Overview
This web service deletes a specified project role and returns the identity of the deleted project role.
Request Format
- PwsDeleteProjectTask
- serviceRequest: PwsDeleteProjectTaskRq
- RequestId: Int32
- SessionTicket: String
- CascadeDeleteFlag: Boolean
- CloseIfInuseFlag: Boolean
- ProjectTaskIdentity: PwsProjectTaskRef
- StealLockFlag: Boolean
- EngagementTimestamp: String
- serviceRequest: PwsDeleteProjectTaskRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | Click here for more information. | |||
SessionTicket | String | Click here for more information. | |||
CascadeDeleteFlag | Boolean | ||||
CloseIfInuseFlag | Boolean | ||||
ProjectTaskIdentity | Yes | This is the identity of the project task to be deleted. Click here for more information. | |||
StealLockFlag | Boolean | No | false | If set to 'true', any locks on the project will be stolen if it is currently locked, otherwise, if it is set to 'false' and a lock is in place the service will fail. | false |
EngagementTimestamp | String | No | This is a Base64 encoded timestamp utilized for engagement locking. To protect against overwriting other changes, you may optionally echo back the timestamp returned by a call to PwsSaveEngagement(or a prior call to PwsSaveEngagement). This will cause the request to fail if any change has been made between invocations of PwsGetEngagement and PwsSaveEngagement. |
Request Usage Example(s)
Response Format
- PwsDeleteProjectTaskResponse
- PwsDeleteProjectTaskResult: PwsDeleteProjectTaskRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- ProjectTaskIdentity: PwsProjectTaskRef
- EngagementTimestamp: String
- LockStolenFromUserIdentity: PwsUserRef
- PwsDeleteProjectTaskResult: PwsDeleteProjectTaskRs
Response Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Messages | |||||
ResponseId | Int32 | Click here for more information. | |||
Status | RequestStatus | Click here for more information. | |||
ServerTimestampUtc | DateTime | Click here for more information. | |||
ProjectTaskIdentity | |||||
EngagementTimestamp | String | ||||
LockStolenFromUserIdentity |
Response Usage Example(s)
Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 54074 | RoleHasHoursBookedOrRequested | This project role cannot be deleted because it has hours booked or requested to it. |