Overview
This web service deletes a specified project task role and returns the identity of the deleted project task role.
Request Format
- PwsDeleteProjectTaskRoleRq
- RequestId: Int32
- SessionTicket: String
- DeallocateIfInuseFlag: Boolean
- ProjectTaskRoleIdentity: PwsProjectTaskRoleRef
- StealLockFlag: Boolean
- EngagementTimestamp: String
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | ||
SessionTicket | String | Yes | Click here for more information. | ||
DeallocateIfInuseFlag | Boolean | No | false | ||
ProjectTaskRoleIdentity | Yes | This is the identity of the project task role 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. | |
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
- PwsDeleteProjectTaskRoleRs
- Messages: PwsMessage
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- ProjectTaskRoleIdentity: PwsProjectTaskRoleRef
- EngagementTimestamp: String
- LockStolenFromUserIdentity: PwsUserRef
Response Elements
Element | Data Type | 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. | |
ProjectTaskRoleIdentity | |||
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 |
---|---|---|
106 | TaskRoleDeallocated | The project task role could not be removed because time has been reported against it. The effort was zeroed out instead. |
54242 | ProjectTaskRoleHasTimeReported | This project task role cannot be deleted because time has been reported against it. |
54274 | ProjectTaskRoleNotFound | The specified project task role does not exist. |