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

1

SessionTicket

String (50)

Yes


Click here for more information

AUcfZP60RNdWSqGygrg5fw==

Engagement

PwsEngagementDetail

Yes


Engagement detail element containing identity of engagement and data to be saved about the engagement


FullDetailFlag

Boolean

Yes


If set to 'true', the full detailed engagement element will be included in the response

true

StealLockFlag

Boolean

Yes


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

UseEtEngagementProjectDefaultsFlag

Boolean

Yes


If set to 'true', and the engagement type is updated, the engagement type defaults for the engagement and the underlying projects (except project workspace defaults) will override existing settings (and any settings explicitly specified here for engagement attributes with defaults at the engagement type level)

true

UseEtProjectWorkspaceDefaultsFlag

Boolean

Yes


If set to 'true', and engagement type is being changed, the engagement type defaults for the project workspace settings for underlying projects will override existing settings

true

EngagementTimestamp

String

No


This is a Base64 encoded timestamp utilized for engagement locking. For internal use onlyTo protect against overwriting other changes, you may optionally echo back the timestamp returned by a call to PwsGetEngagement (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.


SuppressCliCreationOnInsertFlag

Boolean

Yes


If set to 'true', a contract line item will not be created upon creation of a new engagement

true

...

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

1

Status

RequestStatus

Click here for more information

Ok

ServerTimestampUtc

DateTime

Click here for more information

2018-01-18T17:08:48.5836504Z

Engagement

PwsEngagementElement

The complete set of information about the engagement


EngagementIdentity

PwsEngagementRef

The unique keys used to identify the engagement


EngagementTimestamp

String

This is a Base64 encoded timestamp utilized for engagement locking. For internal use only.

AAAAAA98Yvs=

LockStolenFromUserIdentity

PwsUserRef

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


...