Overview
This web service deletes a specified project cost baseline (PwsProjectCostBaselineRef). The service will return the identity of the deleted project cost baseline (PwsProjectCostBaselineRef).
Request Format
| 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. | AXQ/wwat2azit9BTwxnZlg== | |
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 PwsGetEngagement. This will cause the request to fail if any change has been made between invocations of PwsGetEngagement and PwsDeleteProjectCostBaseline. | ||
ProjectCostBaselineIdentity | Yes | The identity of the project cost 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. | true |
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:PwsDeleteProjectCostBaseline>
<pws:serviceRequest>
<req:SessionTicket>AXQ/wwat2azit9BTwxnZlg==</req:SessionTicket>
<sch:ProjectCostBaselineIdentity>
<com:ProjectCostBaselineUid>1152921504607270663</com:ProjectCostBaselineUid>
</sch:ProjectCostBaselineIdentity>
<sch:StealEngagementLockFlag>true</sch:StealEngagementLockFlag>
</pws:serviceRequest>
</pws:PwsDeleteProjectCostBaseline>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
| 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. | |
Status | Click here for more information. | ||
ServerTimestampUtc | DateTime | Click here for more information. | |
EngagementLockStolenFromUserIdentity | If a lock is stolen in the process of updating an engagement, this identifies the user from whom the lock was stolen. | ||
EngagementTimestamp | String | This is a Base64 encoded timestamp optionally used for engagement locking |
Response Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsDeleteProjectCostBaselineResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsDeleteProjectCostBaselineResult 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-05T21:16:21.9568322Z</ServerTimestampUtc>
<a:EngagementLockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<a:EngagementTimestamp>AAAAAA+QecQ=</a:EngagementTimestamp>
<a:ProjectCostBaselineIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:ExternalSystemIdentifier i:nil="true"/>
<b:ProjectCostBaselineId i:nil="true"/>
<b:ProjectCostBaselineUid>1152921504607270663</b:ProjectCostBaselineUid>
</a:ProjectCostBaselineIdentity>
</PwsDeleteProjectCostBaselineResult>
</PwsDeleteProjectCostBaselineResponse>
</s:Body>
</s:Envelope> |
PwsDeleteProjectCostBaseline - 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. |
| 54879 | SpecifiedProjectCostBaselineNotFound | Specified project cost baseline was not found. |
| 54883 | ProjectCostBaselineRefRequired | A project cost baseline must be specified. |