Overview
This web service deletes a specified project task type and returns the identity of the deleted project task type.
Request Format
- PwsDeleteProjectTaskType
- serviceRequest: PwsDeleteProjectTaskTypeRq
- RequestId: Int32
- SessionTicket: String
- InactivateIfInuseFlag: Boolean
- ProjectTaskTypeIdentity: PwsProjectTaskTypeRef
- StealLockFlag: Boolean
- EngagementTimestamp: String
- serviceRequest: PwsDeleteProjectTaskTypeRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | Click here for more information. | |||
SessionTicket | String | Yes | Click here for more information. | ||
InactivateIfInuseFlag | Boolean | No | false | If set to 'true' | |
ProjectTaskTypeIdentity | Yes | This is the identity of the project task type 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
- PwsDeleteProjectTaskTypeResponse
- PwsDeleteProjectTaskTypeResult: PwsDeleteProjectTaskTypeRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- ProjectTaskTypeIdentity: PwsProjectTaskTypeRef
- EngagementTimestamp: String
- LockStolenFromUserIdentity: PwsUserRef
- PwsDeleteProjectTaskTypeResult: PwsDeleteProjectTaskTypeRs
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. | |
Status | RequestStatus | Click here for more information. | |
ServerTimestampUtc | DateTime | Click here for more information. | |
ProjectTaskTypeIdentity | This is the identity of the project task type 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 |
|---|---|---|
| 102 | TaskTypeInactivated | The project task type is in use and cannot be deleted. It was marked inactive instead. |
| 54099 | ProjectTaskTypeAssignedToTask | This project task type cannot be deleted because it is referenced by at least one project task. |