Versions Compared

Key

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

Overview


This web service updates a single project cost baseline based on a detailed project cost baseline detail structure (PwsProjectCostBaselineDetail). The service returns the identity of the project cost baseline (PwsProjectCostBaselineRef) that has been updated. If the FullDetailFlag is set to 'true', the full detailed project cost baseline element (PwsProjectCostBaselineElement) will also be returned in the response.

...

Panel
titlePwsUpdateProjectCostBaseline Request
  • PwsUpdateProjectCostBaseline
    • serviceRequest: PwsUpdateProjectCostBaselineRq
      • RequestId: Int32
      • SessionTicket: String
      • BaselineBucketsClearFlag: Boolean
      • DescriptionClearFlag: Boolean
      • EngagementTimestamp: String **deprecated**
      • ExternalSystemIdentifierClearFlag: Boolean
      • FullDetailFlag: Boolean
      • NewExternalSystemIdentifier: String (50)
      • ProjectCostBaseline: PwsProjectCostBaselineDetail
      • StealEngagementLockFlag: Boolean **deprecated**
      • LocksToSteal: PwsEntityLockSummary[1.100]
      • ProjectorLockSetId: Int32

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

**deprecated**




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

**deprecated**




LocksToStealPwsEntityLockSummary[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.
ProjectorLockSetIdInt32No
A projector lock set id is an identifier for a group of one or more locks held as a unit.

...

Panel
titlePwsUpdateProjectCostBaseline Response

...

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

**deprecated**


EngagementTimestamp

String

**deprecated**


ProjectCostBaseline

PwsProjectCostBaselineElement

This structure contains the complete set of information about a project cost baseline.


ProjectCostBaselineIdentity

PwsProjectCostBaselineRef

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


CostBaselineTimestampStringThis 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.AAAAABFFCOw=
StolenLocksPwsEntityLockSummaryThis structure contains information about the locks that were stolen in order to complete this request, Will be included only when LocksToSteal is specified in the request.

...