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 | No | false | If set to 'true', deleting a parent task deletes all children tasks. | true |
CloseIfInuseFlag | Boolean | No | true | If set to 'true', set task to not open for time if it is already being used (ex. time reported on this task). | true |
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 in a prior response. This will cause the request to fail if any change has been made between the two invocations. |
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 | Description | Sample Data |
|---|---|---|---|
Messages | |||
ResponseId | Int32 | Click here for more information. | 0 |
Status | RequestStatus | Click here for more information. | Ok |
ServerTimestampUtc | DateTime | Click here for more information. | |
ProjectTaskIdentity | This is the identity of the project task that was deleted. Click here for more information. | ||
EngagementTimestamp | String | See EngagementTimestamp above in Request Elements table | |
LockStolenFromUserIdentity | If a lock is stolen in the process of updating an engagement, this identifies the user from which the lock was stolen from. Click here for more information. |
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 |
|---|---|---|
| 54202 | TaskHasChildTasks | This project task cannot be deleted because it has child tasks. Specify CascadeDeleteFlag to recursively delete child tasks. |