...
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 | 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 | 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)
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> |
...
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 | 2018-03-01T19:53:10.2230806Z |
EngagementLockStolenFromUserIdentity | 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 | This structure contains the complete set of information about a project time baseline (less any subordinate entities) |
ProjectTimeBaselineIdentity | This structure represents the unique key fields associated with identifying a project time baseline |
Response Usage Example(s)
...