Overview
This web service deletes a specified resource (PwsResourceRef). The service will return the identity of the resource that was deleted.
Request Format
- PwsDeleteResourceRq
- RequestId: Int32
- SessionTicket: String
- PurgeFutureResourceHistoryFlag: Boolean
- ResourceIdentity: PwsResourceRef
- ResourceTimestamp: String
- TerminationDateIfInUse: DateTime
Request Elements
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 | Click here for more information | AWeOOZxrFCHSwxj9X5YBug== |
PurgeFutureResourceHistoryFlag | Boolean | No | false | If set to true, the resource's history record will be purged from the database | true |
ResourceIdentity | 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 resource |
Request Usage Example(s)
Response Format
- PwsDeleteResourceRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- ResourceIdentity: PwsResourceRef
- Timestamp: String
Response Elements
Element | Data Type | Description | Sample Data |
---|---|---|---|
Messages | 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 | The unique key fields associated with identifying a resource | ||
Timestamp | String | This is a Base64 encoded timestamp optionally utilized for resource locking. |
Response Usage Example(s)
PwsDeleteResource - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
50024 | EntityNotFound | Entity PwsResourceRef was not found. |
50070 | AccessPermissionDenied | Permission denied. |