Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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 Request

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 PwsGetEngagement. This will cause the request to fail if any change has been made between invocations of PwsGetEngagement and PwsDeleteProjectTimeBaseline


ProjectTimeBaselineIdentity

PwsProjectTimeBaselineRef

Yes 


The identity of the project time baseline to be deleted. 


StealEngagementLockFlag

Boolean

No 

false

If set to 'true', any lock 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.

false

Request Usage Example(s)


Example 01
<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>

Response Format


PwsDeleteProjectTimeBaseline Response

Response Elements


Element

Data Type

Description

Sample Data

Messages

PwsMessage [ ]

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information.

0

Status

RequestStatus

Click here for more information.

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-02-06T14:07:40.4977589Z

EngagementLockStolenFromUserIdentity

PwsUserRef

If a lock is stolen in the process of deleting the time baseline, this identifies the user from whom the lock was stolen. 


EngagementTimestamp

String

This is a Base64 encoded timestamp optionally utilized for engagement locking 

AAAAAA62H1M=

ProjectTimeBaselineIdentity

PwsProjectTimeBaselineRef

The unique keys used to identify the project time baseline


Response Usage Example(s)


Example 01
<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>
  • No labels