Versions Compared

Old Version 22

changes.mady.by.user Min Zeng

Saved on

compared with

New Version 23

changes.mady.by.user Min Zeng

Saved on

Key

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

Overview


This web service inserts a single project time baseline based on a detailed project time baseline structure (PwsProjectTimeBaselineDetail). A project time baseline is the basis for a budget.  A baseline can be very simple - this project must be completed within 100 hours. Or very complex - this project has three tasks and each task cannot cost the client more than $3,000 every week. This help document guides you through the baseline creation process. The service returns the identity of the project time baseline (PwsProjectTimeBaselineRef) that has been inserted. The caller can optionally request that the full project time baseline detail (PwsProjectTimeBaselineElement) be included in the response. 

...

Panel
titlePwsCreateProjectTimeBaseline Request

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information


SessionTicket

String

Yes


Click here for more information


ActualsCutoffDate

DateTime

No


The actuals cutoff date for the project time baseline. This is used when you specify a basis of 'A' or 'B', and specifies the cutoff point after which scheduled (booked or requested) hours are used to populate the budget buckets instead of actuals.


Basis

String

Yes


The project time baseline basis. This is used to determine how to populate the initial baseline buckets. For example, if the basis is specified as 'S', the initial budget values will be set based on the hours currently scheduled on the project (or the financial amounts associated with those hours, depending upon the selected metric(s)). This should be one of:

"T" for task plan

"R" for resource requested hours

"P" for resource previously requested hours

"S" for resource scheduled hours

"A" for approved and currently requested hours

"B" for approved and currently booked hours

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


Dimension

String

Yes


The project time baseline dimension. The dimension identifies how the budget is to be broken up. For example, a budget with a dimension of 'R' allows for a budget number to be specified for each role on the project. This should be one of:

"M" for rate type

"K" for task type

"D" for resource department

"T" for resource title

"R" for role

"S" for resource

"N" for none


EngagementTimestamp

String

**deprecated**




FullDetailFlag

Boolean

No

false

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


IntervalCount

Int32

Yes


The interval count or number of buckets of the project time baseline. This applies for time phases other than 'N' (None). Leave NULL for non time-phased budgets.


ProjectIdentity

PwsProjectRef

Yes


The project to which the time baseline should be added


ProjectTimeBaseline

PwsProjectTimeBaselineDetail

Yes


Details of the project time 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. 


StartDate

DateTime

Yes


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


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 


TimePhase

String

Yes


The time phase associated with the project time baseline:

"N" for none

"D" for daily

"W" for weekly

"H" for hourly

"M" for monthly

"Q" for quarterly

"Y" for yearly


LocksToStealPwsEntityLockSummaryNo
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.
RateTaskTimestampStringNo(question)

Request Usage Example(s)

...


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.

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://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsCreateProjectTimeBaseline>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>Af2v8Ie/yFiUtqHqc3felw==</req:SessionTicket>
            <sch:ActualsCutoffDate>2018-03-31T00:00:00.000Z</sch:ActualsCutoffDate>
            <sch:Basis>N</sch:Basis>
            <sch:Dimension>S</sch:Dimension>
            <sch:FullDetailFlag>false</sch:FullDetailFlag>
            <sch:IntervalCount>3</sch:IntervalCount>
            <sch:ProjectIdentity>
               <com:ProjectCode>P001407-001</com:ProjectCode>
            </sch:ProjectIdentity>
            <sch:ProjectTimeBaseline>
               <com:ActiveProjectTimeBaselineFlag>true</com:ActiveProjectTimeBaselineFlag>
               <com:BarMetricActiveFlag>true</com:BarMetricActiveFlag>
               <com:ChgMetricActiveFlag>false</com:ChgMetricActiveFlag>
               <com:CrMetricActiveFlag>false</com:CrMetricActiveFlag>
               <com:Description>Billing Adjusted Revenue Baseline</com:Description>
               <com:HrsMetricActiveFlag>false</com:HrsMetricActiveFlag>
               <com:PrimaryMetric>B</com:PrimaryMetric>
               <com:ProjectTimeBaselineName>BAR Baseline</com:ProjectTimeBaselineName>
               <com:RdcMetricActiveFlag>false</com:RdcMetricActiveFlag>
               <com:ProjectTimeBaselineBuckets>
                  <com:PwsProjectTimeBaselineBucket>
                     <com:BillingAdjustedRevenue>550</com:BillingAdjustedRevenue>
                     <com:EndDate>2018-01-31T00:00:00.000Z</com:EndDate>
                     <com:ResourceIdentity>
                        <com:ResourceReferenceSystemId>PS (USA) - 02</com:ResourceReferenceSystemId>
                     </com:ResourceIdentity>
                     <com:StartDate>2018-01-01T00:00:00.000Z</com:StartDate>
                  </com:PwsProjectTimeBaselineBucket>
                  <com:PwsProjectTimeBaselineBucket>
                     <com:BillingAdjustedRevenue>550</com:BillingAdjustedRevenue>
                     <com:EndDate>2018-02-28T00:00:00.000Z</com:EndDate>
                     <com:ResourceIdentity>
                        <com:ResourceReferenceSystemId>PS (USA) - 02</com:ResourceReferenceSystemId>
                     </com:ResourceIdentity>
                     <com:StartDate>2018-02-01T00:00:00.000Z</com:StartDate>
                  </com:PwsProjectTimeBaselineBucket>
                  <com:PwsProjectTimeBaselineBucket>
                     <com:BillingAdjustedRevenue>550</com:BillingAdjustedRevenue>
                     <com:EndDate>2018-03-31T00:00:00.000Z</com:EndDate>
                     <com:ResourceIdentity>
                        <com:ResourceReferenceSystemId>PS (USA) - 02</com:ResourceReferenceSystemId>
                     </com:ResourceIdentity>
                     <com:StartDate>2018-03-01T00:00:00.000Z</com:StartDate>
                  </com:PwsProjectTimeBaselineBucket>
               </com:ProjectTimeBaselineBuckets>
            </sch:ProjectTimeBaseline>
            <sch:StartDate>2018-01-01T00:00:00.000Z</sch:StartDate>
            <sch:StealEngagementLockFlag>true</sch:StealEngagementLockFlag>
            <sch:TimePhase>M</sch:TimePhase>
         </pws:serviceRequest>
      </pws:PwsCreateProjectTimeBaseline>
   </soapenv:Body>
</soapenv:Envelope>

...

Panel
titlePwsCreateProjectTimeBaseline 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

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


ProjectTimeBaseline

PwsProjectTimeBaselineElement

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


ProjectTimeBaselineIdentity

PwsProjectTimeBaselineRef

The unique keys used to identify the project time baseline 


RateTaskTimestampStringThis 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.

Response Usage Example(s)

...