Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information

1

SessionTicket

String

Yes


Click here for more information

AWeOOZxrFCHSwxj9X5YBug==

PurgeFutureResourceHistoryFlag

Boolean

No

false

This applies only if the resource cannot be deleted and TerminationDateIfInUse is specified. In that case, it will attempt to terminate the resource as of the specified date instead. If this flag is not set, and there are future resource history records for this resource, the request will fail. If this flag is set to true, the future resource 's history record will be purged from the databasehistory records will be deleted and the resource will be terminated as of the specified date.

true

ResourceIdentity

PwsResourceRef

Yes


The unique key fields associated with identifying a resource.


ResourceTimestamp

String

No


This is a Base64 encoded timestamp optionally utilized for resource locking.


TerminationDateIfInUse

DateTime

No


The termination date of the resourceIf a date is specified for TerminationDateIfInUse, and the resource cannot be deleted because it is referenced elsewhere in the system, the resource will be terminated as of the specified date instead. Otherwise, the request will fail.


Request Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsDeleteResource>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AWeOOZxrFCHSwxj9X5YBug==</req:SessionTicket>
            <req:PurgeFutureResourceHistoryFlag>true</req:PurgeFutureResourceHistoryFlag>
            <req:ResourceIdentity>
               <com:ResourceReferenceSystemId>temporary_resource</com:ResourceReferenceSystemId>
            </req:ResourceIdentity>
         </pws:serviceRequest>
      </pws:PwsDeleteResource>
   </soapenv:Body>
</soapenv:Envelope>

...

Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

 The web service response status and message. Click here for more information


ResponseId

Int32

 Click here for more information

1

Status

RequestStatus

 Click here for more information

Ok

ServerTimestampUtc

DateTime

 Click here for more information

2018-10-17T16:39:41.3893819Z

ResourceIdentity

PwsResourceRef

The unique key fields associated with identifying a resource.


Timestamp

String

 This is a Base64 encoded timestamp optionally utilized for resource locking. This will be populated only resource was not deleted (i.e. it was terminated or could not be deleted).


Response Usage Example(s)

...

ErrorNumber

ErrorCode

ErrorText

50024EntityNotFoundEntity PwsResourceRef was not found.
50070AccessPermissionDeniedPermission denied.
57713CannotDeleteReferencedResourceResource cannot be deleted because it is referenced by [Client/Project/Engagement/Role/Resource] Resource-Type UDF.