Versions Compared

Old Version 29

changes.mady.by.user Min Zeng

Saved on

compared with

New Version Current

changes.mady.by.user Bettina Borces

Saved on

Key

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

Overview

...

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. 

...

Panel
titlePwsCreateProjectCostBaseline Request
  • PwsCreateProjectCostBaseline
    • serviceRequest: PwsCreateProjectCostBaselineRq
      • RequestId: Int32
      • SessionTicket: String
      • ActualsCutoffDate: DateTime
      • Basis: String
      • Dimension: String
      • EngagementTimestamp: String **deprecated**
      • FullDetailFlag: Boolean
      • IntervalCount: Int32 **deprecated**
      • ProjectCostBaseline: PwsProjectCostBaselineDetail
      • ProjectIdentity: PwsProjectRef
      • StartDate: DateTime: DateTime **deprecated**
      • StealEngagementLockFlag: Boolean **deprecated**
      • TimePhase: String
      • LocksToSteal: PwsEntityLockSummary [1..100]
      • ProjectTimestamp: String
      • ProjectorLockSetId: Int32

...

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.**deprecated**




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.
IntervalCount
Int32
**deprecated**


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
project to which the cost baseline should be added.

StartDate
DateTime
**deprecated**


2018-01-01T00:00:00.000Z
StealEngagementLockFlag
Boolean
**deprecated**



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
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.
ProjectTimestampStringNo(question)
This 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.
AAAAAA62D3k=
ProjectorLockSetIdInt32No
A projector lock set id is an identifier for a group of one or more locks held as a unitidentifier for a group of one or more locks held as a unit. If the session ticket owner for this request is also the holder of a lock in this set, the request can proceed and will not be blocked by the lock.
Request Usage Example(s)
...
 Code Block
languagexml
titleExample 01
collapsetrue
<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://projectorpsaschemas.xmlsoap.comorg/DataContractssoap/Sharedenvelope/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>
    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>
        <sch:IntervalCount>2</sch:IntervalCount><pws:PwsCreateProjectCostBaseline>
            <sch:ProjectCostBaseline><pws:serviceRequest>
               <com:ActiveProjectCostBaselineFlag>true</com:ActiveProjectCostBaselineFlag><req:RequestId>1</req:RequestId>
               <com:CaMetricActiveFlag>true</com:CaMetricActiveFlag><req:SessionTicket>AXoSoNYPC/IRu5ISV3f2Ew==</req:SessionTicket>
               <com:DaMetricActiveFlag>false</com:DaMetricActiveFlag>
               <com:Description>Client Amount Cost Baseline</com:Description><sch:ActualsCutoffDate>2018-03-31T00:00:00.000Z</sch:ActualsCutoffDate>
               <com:EaMetricActiveFlag>false</com:EaMetricActiveFlag><sch:Basis>N</sch:Basis>
               <com:PrimaryMetric>C</com:PrimaryMetric><sch:Dimension>E</sch:Dimension>
               <com:ProjectCostBaselineName>Client Amount Budget</com:ProjectCostBaselineName><sch:FullDetailFlag>true</sch:FullDetailFlag>
            <sch:IntervalCount>2</sch:IntervalCount>
   <com:ProjectCostBaselineBuckets>         <sch:ProjectCostBaseline>
         <com:PwsProjectCostBaselineBucket>      <com:ActiveProjectCostBaselineFlag>true</com:ActiveProjectCostBaselineFlag>
               <com:ClientAmount>2000<CaMetricActiveFlag>true</com:ClientAmount>CaMetricActiveFlag>
                     <com:EndDate>2018-01-31T00:00:00.000Z<DaMetricActiveFlag>false</com:EndDate>DaMetricActiveFlag>
                     <com:ExpenseTypeIdentity>Description>Client         Amount Cost Baseline</com:Description>
               <com:ExpenseTypeName>Per Diem<EaMetricActiveFlag>false</com:ExpenseTypeName>EaMetricActiveFlag>
                     <<com:PrimaryMetric>C</com:ExpenseTypeIdentity>PrimaryMetric>
               <com:ProjectCostBaselineName>Client      <com:StartDate>2018-01-01T00:00:00.000Z<Amount Budget</com:StartDate>ProjectCostBaselineName>
                  </com:PwsProjectCostBaselineBucket><com:ProjectCostBaselineBuckets>
                  <com:PwsProjectCostBaselineBucket>
                     <com:ClientAmount>2000</com:ClientAmount>
                     <com:EndDate>2018-0201-28T0031T00:00:00.000Z</com:EndDate>
                     <com:ExpenseTypeIdentity>
                        <com:ExpenseTypeName>Per Diem</com:ExpenseTypeName>
                     </com:ExpenseTypeIdentity>
                     <com:StartDate>2018-0201-01T00:00:00.000Z</com:StartDate>
                  </com:PwsProjectCostBaselineBucket>
               </com:ProjectCostBaselineBuckets>             </sch:ProjectCostBaseline>
     <com:PwsProjectCostBaselineBucket>
      <sch:ProjectIdentity>                <com:ProjectCode>P001407-001<ClientAmount>2000</com:ProjectCode>ClientAmount>
            </sch:ProjectIdentity>             <sch<com:StartDate>2018EndDate>2018-0102-01T0028T00:00:00.000Z</schcom:StartDate>EndDate>
            <sch:StealEngagementLockFlag>false</sch:StealEngagementLockFlag>             <sch:TimePhase>M</sch:TimePhase><com:ExpenseTypeIdentity>
         </pws:serviceRequest>       </pws:PwsCreateProjectCostBaseline>    </soapenv:Body> </soapenv:Envelope>
 Code Block
languagexml
titleExample 02 - lock stolen
collapsetrue
<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> <com:ExpenseTypeName>Per Diem</com:ExpenseTypeName>
                     </com:ExpenseTypeIdentity>
      <pws:PwsCreateProjectCostBaseline>          <pws:serviceRequest>       <com:StartDate>2018-02-01T00:00:00.000Z</com:StartDate>
     <req:RequestId>1</req:RequestId>             <req:SessionTicket>Ade8vXDjCIr0kcDpdVTbCw==</req:SessionTicket>com:PwsProjectCostBaselineBucket>
               <sch:ActualsCutoffDate>2018-12-31T00:00:00.000Z</sch:ActualsCutoffDate></com:ProjectCostBaselineBuckets>
            <sch:Basis>N<</sch:Basis>ProjectCostBaseline>
            <sch:Dimension>E</sch:Dimension>ProjectIdentity>
               <sch<com:FullDetailFlag>true<ProjectCode>P001407-001</schcom:FullDetailFlag>ProjectCode>
            <sch</sch:ProjectCostBaseline>ProjectIdentity>
               <com:ActiveProjectCostBaselineFlag>true</com:ActiveProjectCostBaselineFlag><sch:StartDate>2018-01-01T00:00:00.000Z</sch:StartDate>
               <com:CaMetricActiveFlag>true</com:CaMetricActiveFlag><sch:StealEngagementLockFlag>false</sch:StealEngagementLockFlag>
               <com:DaMetricActiveFlag>false</com:DaMetricActiveFlag><sch:TimePhase>M</sch:TimePhase>
         </pws:serviceRequest>
      <com:Description>Client Amount Cost Baseline</com:Description>
               <com:EaMetricActiveFlag>false</com:EaMetricActiveFlag>
               <com:PrimaryMetric>C</com:PrimaryMetric>
       </pws:PwsCreateProjectCostBaseline>
   </soapenv:Body>
</soapenv:Envelope>

 Code Block
languagexml
titleExample 02 - lock stolen
collapsetrue
<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>
       <com:ProjectCostBaselineName>Client Amount Budget</com:ProjectCostBaselineName><pws:PwsCreateProjectCostBaseline>
               <com:ProjectCostBaselineBuckets><pws:serviceRequest>
             <req:RequestId>1</req:RequestId>
    <com:PwsProjectCostBaselineBucket>        <req:SessionTicket>Ade8vXDjCIr0kcDpdVTbCw==</req:SessionTicket>
             <com:ClientAmount>2000</com:ClientAmount><sch:ActualsCutoffDate>2018-12-31T00:00:00.000Z</sch:ActualsCutoffDate>
            <sch:Basis>N</sch:Basis>
        <com:ExpenseTypeIdentity>    <sch:Dimension>E</sch:Dimension>
            <sch:FullDetailFlag>true</sch:FullDetailFlag>
       <com:ExpenseTypeName>Per Diem-AA</com:ExpenseTypeName>    <sch:ProjectCostBaseline>
                 <<com:ActiveProjectCostBaselineFlag>true</com:ExpenseTypeIdentity>ActiveProjectCostBaselineFlag>
                  <<com:CaMetricActiveFlag>true</com:PwsProjectCostBaselineBucket>
  CaMetricActiveFlag>
               <com:PwsProjectCostBaselineBucket>DaMetricActiveFlag>false</com:DaMetricActiveFlag>
               <com:Description>Client Amount     <com:ClientAmount>2000<Cost Baseline</com:ClientAmount>Description>
               <com:EaMetricActiveFlag>false</com:EaMetricActiveFlag>
     <com:ExpenseTypeIdentity>          <com:PrimaryMetric>C</com:PrimaryMetric>
               <com:ExpenseTypeName>Travel-AR<ProjectCostBaselineName>Client Amount Budget</com:ExpenseTypeName>ProjectCostBaselineName>
               <com:ProjectCostBaselineBuckets>
     </com:ExpenseTypeIdentity>             <com:PwsProjectCostBaselineBucket>
     </com:PwsProjectCostBaselineBucket>                <<com:ClientAmount>2000</com:ProjectCostBaselineBuckets>ClientAmount>
                 </sch:ProjectCostBaseline>    <com:ExpenseTypeIdentity>
        <sch:ProjectIdentity>                <com:ProjectCode>P001125ExpenseTypeName>Per Diem-001<AA</com:ProjectCode>ExpenseTypeName>
             </sch:ProjectIdentity>        </com:ExpenseTypeIdentity>
    <!--sch:StartDate>2018-11-01T00:00:00.000Z</sch:StartDate-->              <sch:StealEngagementLockFlag>false<</schcom:StealEngagementLockFlag>PwsProjectCostBaselineBucket>
              <sch:TimePhase>N</sch:TimePhase>    <com:PwsProjectCostBaselineBucket>
        <sch:LocksToSteal>             <com:ClientAmount>2000</com:ClientAmount>
  <!--Zero or more repetitions:-->                <com:PwsEntityLockSummary>ExpenseTypeIdentity>
                        <!--Optional:--><com:ExpenseTypeName>Travel-AR</com:ExpenseTypeName>
                  <com:EntityIdentity>   </com:ExpenseTypeIdentity>
                  <!--Optional:-->/com:PwsProjectCostBaselineBucket>
               </com:ProjectCostBaselineBuckets>
            </sch:ProjectCostBaseline>
      <com:EntityCode>P001125-001</com:EntityCode>      <sch:ProjectIdentity>
               <com:LockType>P<ProjectCode>P001125-001</com:LockType>ProjectCode>
                  </com:EntityIdentity>
     sch:ProjectIdentity>
            <!--Optional:sch:StartDate>2018-11-01T00:00:00.000Z</sch:StartDate-->
            <sch:StealEngagementLockFlag>false</sch:StealEngagementLockFlag>
            <com:EntityLockSummary><sch:TimePhase>N</sch:TimePhase>
            <sch:LocksToSteal>
         <!--Zero or more repetitions:-->   <com:PwsEntityLockSummary>
                  <com:PwsEntityLockSummaryItem>EntityIdentity>
                        <!--Optional:-->
  <com:EntityCode>P001125-001</com:EntityCode>
                     <com:LockCount>1<LockType>P</com:LockCount>LockType>
                  </com:EntityIdentity>
         <!--Optional:-->         <com:EntityLockSummary>
               <com:LockHolderUserIdentity>      <com:PwsEntityLockSummaryItem>
                     <!--Optional:-->   <com:LockCount>1</com:LockCount>
                        <com:UserDisplayName>Krakauer, Larry</com:UserDisplayName>LockHolderUserIdentity>
                           <<com:UserDisplayName>Krakauer, Larry</com:LockHolderUserIdentity>UserDisplayName>
                        <!--Optional:-->/com:LockHolderUserIdentity>
                        <com:MostRecentLockAcquisitionTimestamp>2018-11-14T17:59:52.2Z</com:MostRecentLockAcquisitionTimestamp>
                     </com:PwsEntityLockSummaryItem>
                  </com:EntityLockSummary>
               </com:PwsEntityLockSummary>
            </sch:LocksToSteal>
         </pws:serviceRequest>
      </pws:PwsCreateProjectCostBaseline>
   </soapenv:Body>
</soapenv:Envelope>
...
 Panel
titlePwsCreateProjectCostBaseline Response
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
**deprecated**

EngagementTimestamp
String
**deprecated**
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

ProjectTimestampStringThis 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=
StolenLocksPwsEntityLockSummary[1..100]This 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.
Response Usage Example(s)
...
ErrorNumber
ErrorCode
ErrorText
34001InvalidValueForProjectCostBaselineBasisThe value specified for cost baseline basis is invalid. Valid values are P for Cost Plan and N for None.
34003InvalidValueForProjectCostBaselineDimensionThe value specified for cost baseline dimension is invalid. Valid values are E for Expense Type, G for Expense Type Group, and N for None.
34005SpecifyUpToOneDimensionInBaselineBucketMore than one dimension specified in Baseline Bucket.
34007ParametersIgnoredForTimePhaseNoneTime Phase Parameters StartDate and IntervalCount are ignored when Time Phase specified as N for None.
34010BaselineMustHaveAtLeastOneMetricBaseline must have at least one metric.
34013NoBucketsSpecifiedOnUnseededBaselineCreationNo buckets were specified on baseline creation with no basis/seed.
34015BaselineDescriptionMayNotBeSpecifiedWhenClearFlagSetBaseline Description may not be specified when clear flag is set.
34016BaselineBucketsMayNotBeProvidedWhenClearFlagSetBaseline Buckets may not be provided when clear flag is set.
50024EntityNotFoundEntity PwsExpenseTypeRef was not found.
50469EntityAlreadyLockedOne or more existing locks prevent acquisition of requested lock
50472LockReleasedLock xxxxx of type P  has been released.
50473InvalidLockInvalid lock specified.
54195InvalidValueForPrimaryMetricAn invalid value was specified for project baseline primary metric.
54284CannotUseThisServiceToUpdateBaselinesThis service can be used to create new baselines only, not to update an existing baseline.
54285BaselineNameIsRequiredA baseline name is required.
54286AtLeastOneBaselineMetricMustBeActiveAt least one metric must be made active.
54292PrimaryBaselineMetricMustBeEnabledPrimary baseline metrics must be an enabled metric in the baseline.
54324InvalidValueSpecifiedForBasisDimensionOrTimephaseAn invalid value was specified for basis, dimension or time phase when creating a project baseline.
54483StartDateOrIntervalCountSpecifiedForNonTimephasedBaselineNon-timephased baselines must not have a start date or an interval count other than zero.
54484StartDateAndIntervalCountRequiredForTimephasedBaselineTimephased baselines require a start date and a positive interval count.
54488NoPermissionToCreateProjectBaselineYou do not have appropriate permissions to create this project baseline.
54489BaselineDimensionMismatchA value for a dimension that does not match the project baseline's dimension setting was specified.
54490BudgetValueSpecifiedForInactiveMetricA budget value was specified for a metric that is not active in the project baseline.
54517NegativeBudgetAmountSpecifiedForProjectBaselineProject baselines may not contain negative budgeted amounts.
54518SpecifiedProjectBaselineBucketDatesInvalidThe specified bucket dates for a project baseline bucket are invalid.
54519DuplicateKeyFoundInBaselineBucketsDuplicate key found in specified baseline buckets.
54520ProjectBaselineNameAlreadyInUseThe specified project baseline name is already in use.
54526ProjectBaselineExternalSystemIdentifierAlreadyInUseThe specified project baseline external system identifier is already in use.
54795InvalidArgumentsToPwsGetBaselineBucketDateIntervalsInvalid arguments have been specified to this service.
54991NoPermissionToUpdateProjectBaselineYou do not have appropriate permissions to update this project baseline.
55140NoPermissionToSetActiveBaselinesNo permission to switch active baselines.