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

Yes 


Click here for more information.

AXoSoNYPC/IRu5ISV3f2Ew==

ActualsCutoffDate

DateTime

No


The actuals cut off date for the project cost baseline. Currently, this is not used in any way, but is present for future use.

2018-03-31T00:00:00.000Z

Basis

String

Yes 


The project cost baseline basis. This is used to determine how to populate the initial baseline buckets. For example, if the basis is specified as 'P', the initial budget values will be set based on the project's current cost plan. This should be one of:

"N" for none"P" for project cost plan

N

"N" for none (buckets specified manually within the ProjectCostBaseline structure)

N

Dimension

String

Yes


The project cost baseline dimension. The dimension identifies how the budget is to be broken up. For example, a budget with a dimension of 'E' allows for a budget number to be specified for each expense type available on the project. This should be one of:

"N" for none

"E" for expense type

"G" for expense type group

E

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 PwsGetEngagement. This will cause the request to fail if any change has been made between when the timestamp was retrieved and when this service is invoked.


FullDetailFlag

Boolean

No

false

If set to 'true', the full detailed project cost baseline element will be included in the response

true

IntervalCount

Int32

Yes


The interval count or number of buckets of the project cost baseline

2

ProjectCostBaseline

PwsProjectCostBaselineDetail

Yes

Details of the project cost baseline that was updated or savedof buckets of the project cost baseline. This applies for time phases other than 'N' (None). Leave NULL for non time-phased budgets.

2

ProjectCostBaseline

PwsProjectCostBaselineDetail

Yes


Details of the project cost baseline to be created. This structure identifies important properties of the baseline, such as the baseline name, which metrics are active and which one is the primary metric. It also contains, when Basis is "N", the individual baseline buckets, broken out by the selected dimension and time phase. 


ProjectIdentity

PwsProjectRef

Yes


The project associated with to which the project cost baseline baseline should be added.


StartDate

DateTime

Yes


The overall start date of the project cost baseline. Leave NULL for non time-phased baselines.

2018-01-01T00:00:00.000Z

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 

false

TimePhase

String

Yes


The time phase associated with the project cost baseline:

"N" for none

"D" for daily

"W" for weekly

"H" for hourly

"M" for monthly

"Q" for quarterly

"Y" for yearly

M

...

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-29T21:55:08.7579802Z

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 optionally utilized for engagement locking.

AAAAAA62DGw=

ProjectCostBaseline

PwsProjectCostBaselineElement

The complete set of information about the project cost baseline. Specify FullDetailFlag = true in request to get this value returned in the response.


ProjectCostBaselineIdentity

PwsProjectCostBaselineRef

The unique keys used to identify the project cost baseline


...