Description: Reads the summarized spreads for the specified projects.
Style: Document/literal wrapped
Input:
Message: ReadProjectSpread
Elements:
Field
| Type
| Description
|
---|
ProjectObjectId
| int
| The unique identifier for the project.You can specify one or more ProjectObjectIds.
|
PeriodType
| SummarizedSpreadPeriodType
string restricted to Week Month Quarter Year FinancialPeriod Day
| Spread period type enumerations are used to specify the spread interval for EPS, project, WBS, Activity, and resource assignment spreads.
|
StartDate
| dateTime
| The start of the time period that you are interested in.
|
EndDate
| dateTime
| The end of the time period that you are interested in
|
IncludeCumulative
| boolean
| Set IncludeCumulative to true to read cumulative spread data.
|
SpreadField
| SummarizedSpreadFieldType
string restricted to ActualCost ActualExpenseCost ActualLaborCost ActualLaborUnits ActualMaterialCost ActualNonlaborCost ActualNonlaborUnits ActualTotalCost AtCompletionExpenseCost AtCompletionLaborCost AtCompletionLaborUnits AtCompletionMaterialCost AtCompletionNonlaborCost AtCompletionNonlaborUnits AtCompletionTotalCost BaselinePlannedExpenseCost BaselinePlannedLaborCost BaselinePlannedLaborUnits BaselinePlannedMaterialCost BaselinePlannedNonlaborCost BaselinePlannedNonlaborUnits BaselinePlannedTotalCost EarnedValueCost EarnedValueLaborUnits EstimateAtCompletionCost EstimateAtCompletionLaborUnits EstimateToCompleteCost EstimateToCompleteLaborUnits PeriodActualCost PeriodActualExpenseCost PeriodActualLaborCost PeriodActualLaborUnits PeriodActualMaterialCost PeriodActualNonLaborCost PeriodActualNonLaborUnits PeriodAtCompletionExpenseCost PeriodAtCompletionLaborCost PeriodAtCompletionLaborUnits PeriodAtCompletionMaterialCost PeriodAtCompletionNonLaborCost PeriodAtCompletionNonLaborUnits PeriodAtCompletionTotalCost PeriodEarnedValueCost PeriodEarnedValueLaborUnits PeriodEstimateAtCompletionCost PeriodEstimateAtCompletionLaborUnits PeriodPlannedValueCost PeriodPlannedValueLaborUnits PlannedExpenseCost PlannedLaborCost PlannedLaborUnits PlannedMaterialCost PlannedNonlaborCost PlannedNonlaborUnits PlannedTotalCost PlannedValueCost PlannedValueLaborUnits RemainingExpenseCost RemainingLaborCost RemainingLaborUnits RemainingMaterialCost RemainingNonlaborCost RemainingNonlaborUnits RemainingTotalCost RemainingLateExpenseCost RemainingLateLaborCost RemainingLateLaborUnits RemainingLateMaterialCost RemainingLateNonlaborCost RemainingLateNonlaborUnits RemainingLateTotalCost
| The fields you want to include in the spread. Specify one to many SpreadField elements.
|
Output:
Message: ReadProjectSpreadResponse
Elements: One to many ProjectSpread elements that contain the following fields:
Field
| Type
| Description
|
---|
ProjectId
| string
| The short code that is assigned to the project.
|
ProjectObjectId
| int
| The unique identifier of the project.
|
StartDate
| dateTime
| The start date of spread data.
|
EndDate
| dateTime
| The end date of the spread data.
|
PeriodType
| SummarizedSpreadPeriodType
string restricted to Week Month Quarter Year FinancialPeriod Day
| Specifies the spread interval for the EPS.
|
Period
| SummarizedSpreadPeriod
StartDate EndDate ActualCost ActualExpenseCost ActualLaborCost ActualLaborUnits ActualMaterialCost ActualNonlaborCost ActualNonlaborUnits ActualTotalCost AtCompletionExpenseCost AtCompletionLaborCost AtCompletionLaborUnits AtCompletionMaterialCost AtCompletionNonlaborCost AtCompletionNonlaborUnits AtCompletionTotalCost BaselinePlannedExpenseCost BaselinePlannedLaborCost BaselinePlannedLaborUnits BaselinePlannedMaterialCost BaselinePlannedNonlaborCost BaselinePlannedNonlaborUnits BaselinePlannedTotalCost EarnedValueCost EarnedValueLaborUnits EstimateAtCompletionCost EstimateAtCompletionLaborUnits EstimateToCompleteCost EstimateToCompleteLaborUnits PlannedExpenseCost PlannedLaborCost PlannedLaborUnits PlannedMaterialCost PlannedNonlaborCost PlannedNonlaborUnits PlannedTotalCost PlannedValueCost PlannedValueLaborUnits RemainingExpenseCost RemainingLaborCost RemainingLaborUnits RemainingMaterialCost RemainingNonlaborCost RemainingNonlaborUnits RemainingTotalCost RemainingLateExpenseCost RemainingLateLaborCost RemainingLateLaborUnits RemainingLateMaterialCost RemainingLateNonlaborCost RemainingLateNonlaborUnits RemainingLateTotalCost PeriodActualCost PeriodActualExpenseCost PeriodActualLaborCost PeriodActualLaborUnits PeriodActualMaterialCost PeriodActualNonLaborCost PeriodActualNonLaborUnits PeriodAtCompletionExpenseCost PeriodAtCompletionLaborCost PeriodAtCompletionLaborUnits PeriodAtCompletionMaterialCost PeriodAtCompletionNonLaborCost PeriodAtCompletionNonLaborUnits PeriodAtCompletionTotalCost PeriodEarnedValueCost PeriodEarnedValueLaborUnits PeriodEstimateAtCompletionCost PeriodEstimateAtCompletionLaborUnits PeriodPlannedValueCost PeriodPlannedValueLaborUnits CumulativeActualCost CumulativeActualExpenseCost CumulativeActualLaborCost CumulativeActualLaborUnits CumulativeActualMaterialCost CumulativeActualNonlaborCost CumulativeActualNonlaborUnits CumulativeActualTotalCost CumulativeAtCompletionExpenseCost CumulativeAtCompletionLaborCost CumulativeAtCompletionLaborUnits CumulativeAtCompletionMaterialCost CumulativeAtCompletionNonlaborCost CumulativeAtCompletionNonlaborUnits CumulativeAtCompletionTotalCost CumulativeBaselinePlannedExpenseCost CumulativeBaselinePlannedLaborCost CumulativeBaselinePlannedLaborUnits CumulativeBaselinePlannedMaterialCost CumulativeBaselinePlannedNonlaborCost CumulativeBaselinePlannedNonlaborUnits CumulativeBaselinePlannedTotalCost CumulativeEarnedValueCost CumulativeEarnedValueLaborUnits CumulativeEstimateAtCompletionCost CumulativeEstimateAtCompletionLaborUnits CumulativeEstimateToCompleteCost CumulativeEstimateToCompleteLaborUnits CumulativePlannedExpenseCost CumulativePlannedLaborCost CumulativePlannedLaborUnits CumulativePlannedMaterialCost CumulativePlannedNonlaborCost CumulativePlannedNonlaborUnits CumulativePlannedTotalCost CumulativePlannedValueCost CumulativePlannedValueLaborUnits CumulativeRemainingExpenseCost CumulativeRemainingLaborCost CumulativeRemainingLaborUnits CumulativeRemainingMaterialCost CumulativeRemainingNonlaborCost CumulativeRemainingNonlaborUnits CumulativeRemainingTotalCost CumulativeRemainingLateExpenseCost CumulativeRemainingLateLaborCost CumulativeRemainingLateLaborUnits CumulativeRemainingLateMaterialCost CumulativeRemainingLateNonlaborCost CumulativeRemainingLateNonlaborUnits CumulativeRemainingLateTotalCost
| One or more SummarizedSpreadPeriods that contain the live activity spread data for the period.
Contains the StartDate, EndDate,
and one or more instances of the following data:
|