Overview

This web service updates a single project time baseline based on a detailed project time baseline detail structure (PwsProjectTimeBaselineDetail). The service returns the identity of the project time baseline (PwsProjectTimeBaselineRef) that has been updated. If the FullDetailFlag is set to 'true', the full detailed project cost baseline element (PwsProjectTimeBaselineElement) will also be returned in the response.

Request Format

PwsUpdateProjectTimeBaseline Request

PwsUpdateProjectTimeBaseline
- serviceRequest: PwsUpdateProjectTimeBaselineRq
  - RequestId: Int32
  - SessionTicket: String
  - BaselineBucketsClearFlag: Boolean
  - DescriptionClearFlag: Boolean
  - EngagementTimestamp: String
  - ExternalSystemIdentifierClearFlag: Boolean
  - FullDetailFlag: Boolean
  - NewExternalSystemIdentifier: String
  - ProjectTimeBaseline: PwsProjectTimeBaselineDetail
  - StealEngagementLockFlag: Boolean

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	AUL1Tsqbhar4SWXC5j9T+w==
BaselineBucketsClearFlag	Boolean	No	false	If set to 'true', the baseline buckets are reset to 0	false
DescriptionClearFlag	Boolean	No	false	If set to 'true', the baseline description is cleared	false
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.
ExternalSystemIdentifierClearFlag	Boolean	No	false	If set to 'true', the external system identifier is cleared	false
FullDetailFlag	Boolean	No	false	If set to true, include full detailed project time baseline element (PwsProjectTimeBaselineElement) in response	false
NewExternalSystemIdentifier	String	No		The external system identifier is a unique identifier for a project cost baseline (may be null, but once set can only be updated to a different, non-null value)	TB-A
ProjectTimeBaseline	PwsProjectTimeBaselineDetail	Yes		This structure contains the complete set of information about a project time baseline.
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)

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:PwsUpdateProjectTimeBaseline>
         <pws:serviceRequest>
            <req:SessionTicket>AUL1Tsqbhar4SWXC5j9T+w==</req:SessionTicket>
            <sch:BaselineBucketsClearFlag>false</sch:BaselineBucketsClearFlag>
            <sch:DescriptionClearFlag>false</sch:DescriptionClearFlag>
            <sch:ExternalSystemIdentifierClearFlag>false</sch:ExternalSystemIdentifierClearFlag>
            <sch:FullDetailFlag>false</sch:FullDetailFlag>
            <sch:NewExternalSystemIdentifier>TB-A</sch:NewExternalSystemIdentifier>
            <sch:ProjectTimeBaseline>
               <com:ProjectTimeBaselineUid>1152921504607411687</com:ProjectTimeBaselineUid>
               <com:ActiveProjectTimeBaselineFlag>true</com:ActiveProjectTimeBaselineFlag>
               <com:BarMetricActiveFlag>true</com:BarMetricActiveFlag>
               <com:ChgMetricActiveFlag>true</com:ChgMetricActiveFlag>
               <com:CrMetricActiveFlag>true</com:CrMetricActiveFlag>
               <com:Description>Time Baseline A</com:Description>
               <com:HrsMetricActiveFlag>true</com:HrsMetricActiveFlag>
               <com:PrimaryMetric>B</com:PrimaryMetric>
               <com:ProjectTimeBaselineName>TB-A</com:ProjectTimeBaselineName>
               <com:RdcMetricActiveFlag>true</com:RdcMetricActiveFlag>
               <com:ProjectTimeBaselineBuckets>
                  <com:PwsProjectTimeBaselineBucket>
                     <com:BillingAdjustedRevenue>1000</com:BillingAdjustedRevenue>
                     <com:EndDate>2018-01-31T00:00:00.000Z</com:EndDate>
                     <com:ProjectTaskTypeIdentity>
                        <com:ProjectTaskTypeUid>1152921504608121881</com:ProjectTaskTypeUid>
                     </com:ProjectTaskTypeIdentity>
                     <com:StartDate>2018-01-01T00:00:00.000Z</com:StartDate>
                  </com:PwsProjectTimeBaselineBucket>
               </com:ProjectTimeBaselineBuckets>
            </sch:ProjectTimeBaseline>
            <sch:StealEngagementLockFlag>true</sch:StealEngagementLockFlag>
         </pws:serviceRequest>
      </pws:PwsUpdateProjectTimeBaseline>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsUpdateProjectTimeBaseline Response

PwsUpdateProjectTimeBaselineResponse
- PwsUpdateProjectTimeBaselineResult: PwsUpdateProjectTimeBaselineRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - EngagementLockStolenFromUserIdentity: PwsUserRef
  - EngagementTimestamp: String
  - ProjectTimeBaseline: PwsProjectTimeBaselineElement
  - ProjectTimeBaselineIdentity: PwsProjectTimeBaselineRef

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-03-01T19:53:10.2230806Z
EngagementLockStolenFromUserIdentity	PwsUserRef	If a lock is stolen in the process of updating an engagement, this identifies the user from which the lock was stolen from
EngagementTimestamp	String	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.	AAAAAA64KwI=
ProjectTimeBaseline	PwsProjectTimeBaselineElement	This structure contains the complete set of information about a project time baseline (less any subordinate entities)
ProjectTimeBaselineIdentity	PwsProjectTimeBaselineRef	This structure represents the unique key fields associated with identifying a project time baseline

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsUpdateProjectTimeBaselineResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsUpdateProjectTimeBaselineResult 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-03-01T19:53:10.2230806Z</ServerTimestampUtc>
            <a:EngagementLockStolenFromUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
               <b:UserId i:nil="true"/>
               <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
               <b:UserUid>1152921504607011056</b:UserUid>
            </a:EngagementLockStolenFromUserIdentity>
            <a:EngagementTimestamp>AAAAAA64KwI=</a:EngagementTimestamp>
            <a:ProjectTimeBaseline i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <a:ProjectTimeBaselineIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ExternalSystemIdentifier i:nil="true"/>
               <b:ProjectTimeBaselineId i:nil="true"/>
               <b:ProjectTimeBaselineUid>1152921504607411687</b:ProjectTimeBaselineUid>
            </a:ProjectTimeBaselineIdentity>
            <a:RateTaskTimestamp>AAAAAA62H1Q=</a:RateTaskTimestamp>
            <a:StolenLocks xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsEntityLockSummaryItem>
                  <b:LockCount>1</b:LockCount>
                  <b:LockHolderUser>
                     <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607011056</b:UserUid>
                     <b:EmailAddress>jack@revcorp.bb</b:EmailAddress>
                     <b:FirstName>Jack</b:FirstName>
                     <b:LastName>Spratt</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </b:LockHolderUser>
                  <b:MostRecentLockAcquisitionTimestamp>2018-03-01T19:31:03.32Z</b:MostRecentLockAcquisitionTimestamp>
               </b:PwsEntityLockSummaryItem>
            </a:StolenLocks>
         </PwsUpdateProjectTimeBaselineResult>
      </PwsUpdateProjectTimeBaselineResponse>
   </s:Body>
</s:Envelope>

PwsUpdateProjectTimeBaseline - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
34000	InvalidValueForProjectTimeBaselineBasis	The value specified for time baseline basis is invalid. Valid values are T for Task Plan, R for Resource Requests, P for Previous Resource Requests, S for Scheduled Resources, A for Approved And Current Requested, B for Approved And Current Booked, and for None.
34002	InvalidValueForProjectTimeBaselineDimension	The value specified for time baseline dimension is invalid. Valid values are M for Rate Type, K for Task Type, D for Resource Department, T for Resource Title, R for Role, S for Resource, and N for None.
54923	SpecifiedProjectTimeBaselineNotFound	Specified project time baseline was not found.
54961	ProjectTimeBaselineRefRequired	A project time baseline must be specified.