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 2 Next »

Overview


This structure contains the complete set of information about a project cost baseline. The structure is used both to retrieve detailed project cost baseline information and to pass information about a project cost baseline back to the server to get updated.

Format


PwsProjectCostBaselineDetail
  • PwsProjectCostBaselineDetail
    • ExternalSystemIdentifier: String
    • ProjectCostBaselineId: Int32
    • ProjectCostBaselineUid: Int64
    • ActiveProjectCostBaselineFlag: Boolean
    • CaMetricActiveFlag: Boolean
    • DaMetricActiveFlag: Boolean
    • Description: String (1000)
    • EaMetricActiveFlag: Boolean
    • PrimaryMetric: String (1)
    • ProjectCostBaselineName: String (50)
    • ProjectCostBaselineBuckets: PwsProjectCostBaselineBucket[]

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ExternalSystemIdentifier

String

One of ExternalSystemIdentifier or ProjectCostBaselineUid is required


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)


ProjectCostBaselineId

Int32

No


The project cost baseline id is a unique identifier for a project cost baseline. For internal use only.  


ProjectCostBaselineUid

Int64

See ExternalSystemIdentifier


A unique and immutable identifier for a project cost baseline  


ActiveProjectCostBaselineFlag

Boolean

On Insert: No

On Update: No 

Defaults to false on create, must be same as existing on update, or null

If set to 'true', the project cost baseline referenced by this web service is set as the active project cost baseline

true


CaMetricActiveFlag

Boolean

On Insert: One of CaMetricActiveFlag, DaMetricActiveFlag or EaMetricActiveFlag is required

On Update: No 

Defaults to false on create, must be same as existing on update, or null

If set to 'true', the client amount is set as a project cost baseline metric 

true


DaMetricActiveFlag

Boolean

See CaMetricActiveFlag 

Defaults to false on create, must be same as existing on update, or null

If set to 'true', the disbursed amount is set as a project cost baseline metric  

false


Description

String (1000)

On Insert: No

On Update: No 


The project cost baseline metric 

Client Amount Cost Baseline


EaMetricActiveFlag

Boolean

See CaMetricActiveFlag 


Defaults to false on create, must be same as existing on update, or null 

If set to 'true', the expense amount is set as a project cost baseline metric  

false


PrimaryMetric

String (1)

Required on create, null means don't change on update 


The primary metric for the project cost baseline

"C" for Client Amount
"D" for Disbursed Amount
"E" for Expense Amount

C


ProjectCostBaselineName

String (50)

On Insert: Yes

On Update: No 


The project cost baseline name 

Client Amount Budget

ProjectCostBaselineBuckets

PwsProjectCostBaselineBucket[]

On Insert: Yes

On Update: No 


The information associated with the project cost baseline buckets


Usage Example(s)


Example 01
           <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>
  • No labels