Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 PwsGetProjectCostBaseline (or a prior call to PwsSaveEngagementPwsUpdateProjectCostBaseline). This will cause the request to fail if any change has been made between invocations of PwsGetEngagement and PwsSaveEngagementPwsGetProjectCostBaselineand PwsUpdateProjectCostBaseline


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 cost baseline element (PwsProjectCostBaselineElement) in response.

true

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).

CB-A

ProjectCostBaseline

PwsProjectCostBaselineDetail

Yes

false

This structure contains the complete set of information about a project cost 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)

...

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-01T18:48:25.5474807Z

EngagementLockStolenFromUserIdentity

PwsUserRef

If a lock is stolen in the process of updating an engagement, this identifies the user from which whom the lock was stolen from.


EngagementTimestamp

StringThis 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 

PwsSaveEngagementSee Request Elements above for more details.


ProjectCostBaseline

PwsProjectCostBaselineElement

This structure contains the complete set of information about a project cost baseline (less any subordinate entities).


ProjectCostBaselineIdentity

PwsProjectCostBaselineRef

This structure represents the unique key fields associated with identifying a project cost baseline.


Response Usage Example(s)

...