Overview

This web service inserts a single project cost baseline based on a detailed project cost baseline structure (PwsProjectCostBaselineDetail). A project cost baseline is the basis for a budget. A baseline can be very simple - this project cannot have costs of more than $5000. Or very complex - this project has a senior sales rep and a junior sales rep. Each is budgeted a specific amount of money per diem. The service returns the identity of the project cost baseline (PwsProjectCostBaselineRef) that has been inserted. The caller can optionally request that the full project cost baseline detail (PwsProjectCostBaselineElement) be included in the response.

Request Format

PwsCreateProjectCostBaseline Request

PwsCreateProjectCostBaseline
- serviceRequest: PwsCreateProjectCostBaselineRq
  - RequestId: Int32
  - SessionTicket: String
  - ActualsCutoffDate: DateTime
  - Basis: String
  - Dimension: String
  - EngagementTimestamp: String
  - FullDetailFlag: Boolean
  - IntervalCount: Int32
  - ProjectCostBaseline: PwsProjectCostBaselineDetail
  - ProjectIdentity: PwsProjectRef
  - StartDate: DateTime
  - StealEngagementLockFlag: Boolean
  - TimePhase: String
  - LocksToSteal: PwsEntityLockSummary[1.100]
  - ProjectTimestamp: String
  - ProjectorLockSetId: Int32

Request Elements

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: "P" for project cost plan "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. 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 to which the cost 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
LocksToSteal	PwsEntityLockSummary[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.
ProjectTimestamp	String	No
ProjectorLockSetId	Int32	No		A projector lock set id is an identifier for a group of one or more locks held as a unit.

Request Usage Example(s)

Example 01

<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:PwsCreateProjectCostBaseline>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AXoSoNYPC/IRu5ISV3f2Ew==</req:SessionTicket>
            <sch:ActualsCutoffDate>2018-03-31T00:00:00.000Z</sch:ActualsCutoffDate>
            <sch:Basis>N</sch:Basis>
            <sch:Dimension>E</sch:Dimension>
            <sch:FullDetailFlag>true</sch:FullDetailFlag>
            <sch:IntervalCount>2</sch:IntervalCount>
            <sch:ProjectCostBaseline>
               <com:ActiveProjectCostBaselineFlag>true</com:ActiveProjectCostBaselineFlag>
               <com:CaMetricActiveFlag>true</com:CaMetricActiveFlag>
               <com:DaMetricActiveFlag>false</com:DaMetricActiveFlag>
               <com:Description>Client Amount Cost Baseline</com:Description>
               <com:EaMetricActiveFlag>false</com:EaMetricActiveFlag>
               <com:PrimaryMetric>C</com:PrimaryMetric>
               <com:ProjectCostBaselineName>Client Amount Budget</com:ProjectCostBaselineName>
               <com:ProjectCostBaselineBuckets>
                  <com:PwsProjectCostBaselineBucket>
                     <com:ClientAmount>2000</com:ClientAmount>
                     <com:EndDate>2018-01-31T00:00:00.000Z</com:EndDate>
                     <com:ExpenseTypeIdentity>
                        <com:ExpenseTypeName>Per Diem</com:ExpenseTypeName>
                     </com:ExpenseTypeIdentity>
                     <com:StartDate>2018-01-01T00:00:00.000Z</com:StartDate>
                  </com:PwsProjectCostBaselineBucket>
                  <com:PwsProjectCostBaselineBucket>
                     <com:ClientAmount>2000</com:ClientAmount>
                     <com:EndDate>2018-02-28T00:00:00.000Z</com:EndDate>
                     <com:ExpenseTypeIdentity>
                        <com:ExpenseTypeName>Per Diem</com:ExpenseTypeName>
                     </com:ExpenseTypeIdentity>
                     <com:StartDate>2018-02-01T00:00:00.000Z</com:StartDate>
                  </com:PwsProjectCostBaselineBucket>
               </com:ProjectCostBaselineBuckets>
            </sch:ProjectCostBaseline>
            <sch:ProjectIdentity>
               <com:ProjectCode>P001407-001</com:ProjectCode>
            </sch:ProjectIdentity>
            <sch:StartDate>2018-01-01T00:00:00.000Z</sch:StartDate>
            <sch:StealEngagementLockFlag>false</sch:StealEngagementLockFlag>
            <sch:TimePhase>M</sch:TimePhase>
         </pws:serviceRequest>
      </pws:PwsCreateProjectCostBaseline>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsCreateProjectCostBaseline Response

PwsCreateProjectCostBaselineResponse
- PwsCreateProjectCostBaselineResult: PwsCreateProjectCostBaselineRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - EngagementLockStolenFromUserIdentity: PwsUserRef
  - EngagementTimestamp: String
  - ProjectCostBaseline: PwsProjectCostBaselineElement
  - ProjectCostBaselineIdentity: PwsProjectCostBaselineRef

Response Elements

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

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsCreateProjectCostBaselineResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsCreateProjectCostBaselineResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-29T21:55:08.7579802Z</ServerTimestampUtc>
            <a:EngagementLockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <a:EngagementTimestamp>AAAAAA62DGw=</a:EngagementTimestamp>
            <a:ProjectCostBaseline xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:Basis>N</b:Basis>
               <b:CreatedByUser>
                  <b:UserDisplayName>Web Services</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>WS01</b:UserReferenceSystemId>
                  <b:UserUid>1152921504607067736</b:UserUid>
                  <b:EmailAddress>webservices@revcorp.bb</b:EmailAddress>
                  <b:FirstName>Web</b:FirstName>
                  <b:LastName>Services</b:LastName>
                  <b:MiddleName i:nil="true"/>
               </b:CreatedByUser>
               <b:CreatedTimestamp>2018-01-29T21:55:02.573Z</b:CreatedTimestamp>
               <b:Dimension>E</b:Dimension>
               <b:EndDate>2018-02-28T00:00:00Z</b:EndDate>
               <b:EngagementTimestamp>AAAAAA62DGw=</b:EngagementTimestamp>
               <b:LastUpdatedByUser>
                  <b:UserDisplayName>Web Services</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>WS01</b:UserReferenceSystemId>
                  <b:UserUid>1152921504607067736</b:UserUid>
                  <b:EmailAddress>webservices@revcorp.bb</b:EmailAddress>
                  <b:FirstName>Web</b:FirstName>
                  <b:LastName>Services</b:LastName>
                  <b:MiddleName i:nil="true"/>
               </b:LastUpdatedByUser>
               <b:LastUpdatedTimestamp>2018-01-29T21:55:02.573Z</b:LastUpdatedTimestamp>
               <b:ProjectCostBaselineBucketDateIntervals>
                  <b:PwsDateInterval>
                     <b:EndDate>2017-12-31T00:00:00Z</b:EndDate>
                     <b:StartDate i:nil="true"/>
                  </b:PwsDateInterval>
                  <b:PwsDateInterval>
                     <b:EndDate>2018-01-31T00:00:00Z</b:EndDate>
                     <b:StartDate>2018-01-01T00:00:00Z</b:StartDate>
                  </b:PwsDateInterval>
                  <b:PwsDateInterval>
                     <b:EndDate>2018-02-28T00:00:00Z</b:EndDate>
                     <b:StartDate>2018-02-01T00:00:00Z</b:StartDate>
                  </b:PwsDateInterval>
                  <b:PwsDateInterval>
                     <b:EndDate i:nil="true"/>
                     <b:StartDate>2018-03-01T00:00:00Z</b:StartDate>
                  </b:PwsDateInterval>
               </b:ProjectCostBaselineBucketDateIntervals>
               <b:ProjectCostBaselineDetail>
                  <b:ExternalSystemIdentifier i:nil="true"/>
                  <b:ProjectCostBaselineId i:nil="true"/>
                  <b:ProjectCostBaselineUid>1152921504607272102</b:ProjectCostBaselineUid>
                  <b:ActiveProjectCostBaselineFlag>true</b:ActiveProjectCostBaselineFlag>
                  <b:CaMetricActiveFlag>true</b:CaMetricActiveFlag>
                  <b:DaMetricActiveFlag>false</b:DaMetricActiveFlag>
                  <b:Description>Cost Budget Baseline</b:Description>
                  <b:EaMetricActiveFlag>false</b:EaMetricActiveFlag>
                  <b:PrimaryMetric>C</b:PrimaryMetric>
                  <b:ProjectCostBaselineName>Client Amount Budget</b:ProjectCostBaselineName>
                  <b:ProjectCostBaselineBuckets>
                     <b:PwsProjectCostBaselineBucket>
                        <b:ClientAmount>2000</b:ClientAmount>
                        <b:DisbursedAmount i:nil="true"/>
                        <b:EndDate>2018-01-31T00:00:00Z</b:EndDate>
                        <b:ExpenseAmount i:nil="true"/>
                        <b:ExpenseTypeGroupIdentity i:nil="true"/>
                        <b:ExpenseTypeIdentity>
                           <b:ExpenseTypeId i:nil="true"/>
                           <b:ExpenseTypeName>Per Diem</b:ExpenseTypeName>
                           <b:ExpenseTypeUid>1152921504606881747</b:ExpenseTypeUid>
                        </b:ExpenseTypeIdentity>
                        <b:StartDate>2018-01-01T00:00:00Z</b:StartDate>
                     </b:PwsProjectCostBaselineBucket>
                     <b:PwsProjectCostBaselineBucket>
                        <b:ClientAmount>2000</b:ClientAmount>
                        <b:DisbursedAmount i:nil="true"/>
                        <b:EndDate>2018-02-28T00:00:00Z</b:EndDate>
                        <b:ExpenseAmount i:nil="true"/>
                        <b:ExpenseTypeGroupIdentity i:nil="true"/>
                        <b:ExpenseTypeIdentity>
                           <b:ExpenseTypeId i:nil="true"/>
                           <b:ExpenseTypeName>Per Diem</b:ExpenseTypeName>
                           <b:ExpenseTypeUid>1152921504606881747</b:ExpenseTypeUid>
                        </b:ExpenseTypeIdentity>
                        <b:StartDate>2018-02-01T00:00:00Z</b:StartDate>
                     </b:PwsProjectCostBaselineBucket>
                  </b:ProjectCostBaselineBuckets>
                  <b:Timestamp>AAAAAA62DG8=</b:Timestamp>
               </b:ProjectCostBaselineDetail>
               <b:StartDate>2018-01-01T00:00:00Z</b:StartDate>
               <b:TimePhase>M</b:TimePhase>
            </a:ProjectCostBaseline>
            <a:ProjectCostBaselineIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ExternalSystemIdentifier i:nil="true"/>
               <b:ProjectCostBaselineId i:nil="true"/>
               <b:ProjectCostBaselineUid>1152921504607272102</b:ProjectCostBaselineUid>
            </a:ProjectCostBaselineIdentity>
            <a:ProjectTimestamp>AAAAAA62DHA=</a:ProjectTimestamp>
            <a:StolenLocks xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
         </PwsCreateProjectCostBaselineResult>
      </PwsCreateProjectCostBaselineResponse>
   </s:Body>
</s:Envelope>

PwsCreateProjectCostBaseline - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
34001	InvalidValueForProjectCostBaselineBasis	The value specified for cost baseline basis is invalid. Valid values are P for Cost Plan and N for None.
34003	InvalidValueForProjectCostBaselineDimension	The value specified for cost baseline dimension is invalid. Valid values are E for Expense Type, G for Expense Type Group, and N for None.
34005	SpecifyUpToOneDimensionInBaselineBucket	More than one dimension specified in Baseline Bucket.
34010	BaselineMustHaveAtLeastOneMetric	Baseline must have at least one metric.
34013	NoBucketsSpecifiedOnUnseededBaselineCreation	No buckets were specified on baseline creation with no basis/seed.
34015	BaselineDescriptionMayNotBeSpecifiedWhenClearFlagSet	Baseline Description may not be specified when clear flag is set.
34016	BaselineBucketsMayNotBeProvidedWhenClearFlagSet	Baseline Buckets may not be provided when clear flag is set.
50024	EntityNotFound	Entity PwsExpenseTypeRef was not found.
50469	EntityAlreadyLocked	One or more existing locks prevent acquisition of requested lock
54195	InvalidValueForPrimaryMetric	An invalid value was specified for project baseline primary metric.
54284	CannotUseThisServiceToUpdateBaselines	This service can be used to create new baselines only, not to update an existing baseline.
54285	BaselineNameIsRequired	A baseline name is required.
54286	AtLeastOneBaselineMetricMustBeActive	At least one metric must be made active.
54292	PrimaryBaselineMetricMustBeEnabled	Primary baseline metrics must be an enabled metric in the baseline.
54324	InvalidValueSpecifiedForBasisDimensionOrTimephase	An invalid value was specified for basis, dimension or time phase when creating a project baseline.
54483	StartDateOrIntervalCountSpecifiedForNonTimephasedBaseline	Non-timephased baselines must not have a start date or an interval count other than zero.
54484	StartDateAndIntervalCountRequiredForTimephasedBaseline	Timephased baselines require a start date and a positive interval count.
54488	NoPermissionToCreateProjectBaseline	You do not have appropriate permissions to create this project baseline.
54489	BaselineDimensionMismatch	A value for a dimension that does not match the project baseline's dimension setting was specified.
54490	BudgetValueSpecifiedForInactiveMetric	A budget value was specified for a metric that is not active in the project baseline.
54517	NegativeBudgetAmountSpecifiedForProjectBaseline	Project baselines may not contain negative budgeted amounts.
54518	SpecifiedProjectBaselineBucketDatesInvalid	The specified bucket dates for a project baseline bucket are invalid.
54519	DuplicateKeyFoundInBaselineBuckets	Duplicate key found in specified baseline buckets.
54520	ProjectBaselineNameAlreadyInUse	The specified project baseline name is already in use.
54526	ProjectBaselineExternalSystemIdentifierAlreadyInUse	The specified project baseline external system identifier is already in use.
54795	InvalidArgumentsToPwsGetBaselineBucketDateIntervals	Invalid arguments have been specified to this service.
54991	NoPermissionToUpdateProjectBaseline	You do not have appropriate permissions to update this project baseline.
55140	NoPermissionToSetActiveBaselines	No permission to switch active baselines.