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.
...
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. | AUL1Tsqbhar4SWXC5j9T+w== | |||||||||||||
BaselineBucketsClearFlag | Boolean | No | false | If set to 'true', the baseline buckets are reset to 0. | false | ||||||||||||
DescriptionClearFlag | SessionTicketBoolean | StringNo | Yes | Click here for more information. | AUL1Tsqbhar4SWXC5j9T+w== | BaselineBucketsClearFlag | Boolean | No | falsefalse | If set to 'true', the baseline description is cleared. | false | ||||||
EngagementTimestamp | String | **deprecated** | |||||||||||||||
ExternalSystemIdentifierClearFlag | Boolean (50) | No | false | If set to 'true', the baseline buckets are reset to 0external system identifier is cleared. | false | ||||||||||||
DescriptionClearFlagFullDetailFlag | Boolean | No | false | If set to ' true', the baseline description is clearedinclude full detailed project time baseline element (PwsProjectTimeBaselineElement) in response. | false | ||||||||||||
EngagementTimestampNewExternalSystemIdentifier | String (50) | 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 PwsGetProjectTimeBaseline (or a prior call to PwsUpdateProjectTimeBaseline). This will cause the request to fail if any change has been made between invocations of PwsGetProjectTimeBaselineand PwsUpdateProjectTimeBaseline. |||||||||||||||
ExternalSystemIdentifierClearFlag | Boolean (50) | 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 (50) | 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 | 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 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 | Yes | This structure contains the complete set of information about a project time baseline. | |||||||||||||||
StealEngagementLockFlag | Boolean | **deprecated** | |||||||||||||||
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. | ||||||||||||||
LocksToSteal | PwsEntityLockSummary[1.100] | 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. |
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: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> |
...