Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 10
Next »
Overview
This web service inserts a single project cost baseline based on a detailed project cost baseline structure (PwsProjectCostBaselineDetail). The service returns the identity (PwsProjectCostBaselineRef) of the project cost baseline that has been inserted. The caller can optionally request that the full project cost baseline detail (PwsProjectCostBaselineRef) be included in the response.
- PwsCreateProjectCostBaseline
- serviceRequest: PwsCreateProjectCostBaselineRq
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 budget baseline | 2018-03-31T00:00:00.000Z |
Basis | String | Yes |
| The project cost baseline basis: "N" for none "P" for project cost plan | N |
Dimension | String | Yes |
| The project cost baseline dimension: "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 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 PwsSaveEngagement. |
|
FullDetailFlag | Boolean | Yes |
| 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 saved |
|
ProjectIdentity | PwsProjectRef | Yes |
| The project associated with the project cost budget baseline |
|
StartDate | DateTime | Yes |
| The overall start date of the project cost budget baseline | 2018-01-01T00:00:00.000Z |
StealEngagementLockFlag | Boolean | Yes | 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 budget baseline: "N" for none "D" for daily "W" for weekly "H" for hourly "M" for monthly "Q" for quarterly "Y" for yearly | M |
Request Usage Example(s)
<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>
- PwsCreateProjectCostBaselineResponse
- PwsCreateProjectCostBaselineResult: PwsCreateProjectCostBaselineRs
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 utilized for engagement locking | AAAAAA62DGw= |
ProjectCostBaseline | PwsProjectCostBaselineElement | The complete set of information about the project cost baseline |
|
ProjectCostBaselineIdentity | PwsProjectCostBaselineRef | The unique keys used to identify the project cost baseline |
|
Response Usage Example(s)
<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>