Overview
This web service deletes a specified project cost time baseline (PwsProjectTimeBaselineRef). The service will return the identity of the deleted project cost time baseline (PwsProjectTimeBaselineRef).
...
| Panel | ||
|---|---|---|
| ||
|
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 |
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.
**deprecated** | |||
ProjectTimeBaselineIdentity | Yes |
The |
identity of the project time |
baseline to be deleted. | |
StealEngagementLockFlag | Boolean |
No
false
If set to 'true', any locks on the engagement 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
**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)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:sch="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsDeleteProjectTimeBaseline>
<pws:serviceRequest>
<req:SessionTicket>ATyYOmHE4QY9aBMdGs0JBg==</req:SessionTicket>
<sch:ProjectTimeBaselineIdentity>
<com:ProjectTimeBaselineUid>1152921504607411676</com:ProjectTimeBaselineUid>
</sch:ProjectTimeBaselineIdentity>
<sch:StealEngagementLockFlag>false</sch:StealEngagementLockFlag>
</pws:serviceRequest>
</pws:PwsDeleteProjectTimeBaseline>
</soapenv:Body>
</soapenv:Envelope> |
...
| Panel | ||
|---|---|---|
| ||
|
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. |
EngagementTimestamp
String
This is a Base64 encoded timestamp optionally utilized for engagement locking
2018-02-06T14:07:40.4977589Z | |
EngagementLockStolenFromUserIdentity |
If a lock is stolen in the process of updating an engagement, this identifies the user from which the lock was stolen from
*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)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsDeleteProjectTimeBaselineResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsDeleteProjectTimeBaselineResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-06T14:07:40.4977589Z</ServerTimestampUtc>
<a:EngagementLockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<a:EngagementTimestamp>AAAAAA62H1M=</a:EngagementTimestamp>
<a:ProjectTimeBaselineIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:ExternalSystemIdentifier i:nil="true"/>
<b:ProjectTimeBaselineId i:nil="true"/>
<b:ProjectTimeBaselineUid>1152921504607411676</b:ProjectTimeBaselineUid>
</a:ProjectTimeBaselineIdentity>
<a:RateTaskTimestamp>AAAAAA62H1Q=</a:RateTaskTimestamp>
<a:StolenLocks xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
</PwsDeleteProjectTimeBaselineResult>
</PwsDeleteProjectTimeBaselineResponse>
</s:Body>
</s:Envelope> |
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. |