PwsDeleteProjectTimeBaseline
Overview
This web service deletes a specified project time baseline (PwsProjectTimeBaselineRef). The service will return the identity of the deleted project time baseline (PwsProjectTimeBaselineRef).
Request Format
- PwsDeleteProjectTimeBaseline
- serviceRequest: PwsDeleteProjectTimeBaselineRq
- RequestId: Int32
- SessionTicket: String
- EngagementTimestamp: String **deprecated**
- ProjectTimeBaselineIdentity: PwsProjectTimeBaselineRef
- StealEngagementLockFlag: Boolean **deprecated**
- LocksToSteal: PwsEntityLockSummary
- ProjectorLockSetId: Int32
- RateTaskTimestamp: String
- serviceRequest: PwsDeleteProjectTimeBaselineRq
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. | ATyYOmHE4QY9aBMdGs0JBg== | |
EngagementTimestamp | String | **deprecated** | |||
ProjectTimeBaselineIdentity | Yes | The identity of the project time baseline to be deleted. | |||
StealEngagementLockFlag | Boolean | **deprecated** | |||
LocksToSteal | PwsEntityLockSummary | No | The detailed information of the locks that are to be stolen. If not specified, the request will fail if any requested locks are already held. If specified, the information supplied must exactly match the current state of existing locks or the attempt to steal the existing locks will fail. Typically, this service is invoked with LocksToSteal empty or null. If there are existing locks, they will be returned in the LockHolders member of PwsFault. This data can then be sent, as is, back to the server in a second invocation of this service, as LocksToSteal, if the caller desires to steal the locks. | ||
ProjectorLockSetId | Int32 | No | A projector lock set id is an identifier for a group of one or more locks held as a unit. | ||
RateTaskTimestamp | String | No | This is an optimistic locking timestamp that, if provided on update request, will cause the request to fail when the timestamp stored in the database does not match the provided value. |
Request Usage Example(s)
Response Format
- PwsDeleteProjectTimeBaselineResponse
- PwsDeleteProjectTimeBaselineResult: PwsDeleteProjectTimeBaselineRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- EngagementLockStolenFromUserIdentity: PwsUserRef *deprecated**
- EngagementTimestamp: String *deprecated**
- ProjectTimeBaselineIdentity: PwsProjectTimeBaselineRef
- RateTaskTimestamp: String
- StolenLocks: PwsEntityLockSummary
- PwsDeleteProjectTimeBaselineResult: PwsDeleteProjectTimeBaselineRs
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. | 0 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-02-06T14:07:40.4977589Z |
EngagementLockStolenFromUserIdentity | *deprecated** | ||
EngagementTimestamp | String | *deprecated** | |
ProjectTimeBaselineIdentity | The unique keys used to identify the project time baseline | ||
RateTaskTimestamp | String | This is an optimistic locking timestamp that, if provided on update request, will cause the request to fail when the timestamp stored in the database does not match the provided value. | |
StolenLocks | PwsEntityLockSummary | This structure contains information about the locks that were stolen in order to complete this request, Will be included only when LocksToSteal is specified in the request. |
Response Usage Example(s)
PwsDeleteProjectTimeBaseline - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
54588 | NoPermissionToDeleteProjectBaseline | You do not have appropriate permission to delete this project baseline. |
54644 | CannotDeleteActiveProjectBaseline | Active project baselines cannot be deleted. |
50024 | EntityNotFound | Project Time Baseline was not found. Another user may have deleted it. |