ReadActivitySpread Operation

Description: Reads the live activity spread data from the specified activities.

Service: Spread Service

Style: Document/literal wrapped

Input:

Message: ReadActivitySpread

Elements:

Field	Type	Description
ActivityObjectId	int	The unique identifier for the activity. You can specify one or more ActivityObjectIds.
PeriodType	SpreadPeriodType string restricted to Hour Day Week Month Quarter Year FinancialPeriod	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	ActivitySpreadFieldType string restricted to ActualCost ActualExpenseCost ActualLaborCost ActualLaborUnits ActualMaterialCost ActualNonLaborCost ActualNonLaborUnits ActualTotalCost AtCompletionExpenseCost AtCompletionLaborCost AtCompletionLaborUnits AtCompletionMaterialCost AtCompletionNonLaborCost AtCompletionNonLaborUnits AtCompletionTotalCost Baseline1ActualExpenseCost Baseline1ActualLaborCost Baseline1ActualLaborUnits Baseline1ActualMaterialCost Baseline1ActualNonLaborCost Baseline1ActualNonLaborUnits Baseline1ActualTotalCost Baseline1PlannedExpenseCost Baseline1PlannedLaborCost Baseline1PlannedLaborUnits Baseline1PlannedMaterialCost Baseline1PlannedNonLaborCost Baseline1PlannedNonLaborUnits Baseline1PlannedTotalCost BaselineActualExpenseCost BaselineActualLaborCost BaselineActualLaborUnits BaselineActualMaterialCost BaselineActualNonLaborCost BaselineActualNonLaborUnits BaselineActualTotalCost 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	The fields you want to include in the spread. Specify one to many SpreadField elements.

Output:

Message: ReadActivitySpreadResponse

Elements: One to many ActivitySpread elements that contain the following fields:

Field	Type	Description
ActivityId	string	The short ID that uniquely identifies the activity.
ActivityObjectId	int	The unique identifier for the activity.
StartDate	dateTime	The start date of spread data.
EndDate	dateTime	The end date of the spread data.
PeriodType	SpreadPeriodType string restricted to Hour Day Week Month Quarter Year FinancialPeriod	Specifies the spread interval for the Activity.
Period	ActivitySpreadPeriod StartDate EndDate ActualCost ActualExpenseCost ActualLaborCost ActualLaborUnits ActualMaterialCost ActualNonLaborCost ActualNonLaborUnits ActualTotalCost AtCompletionExpenseCost AtCompletionLaborCost AtCompletionLaborUnits AtCompletionMaterialCost AtCompletionNonLaborCost AtCompletionNonLaborUnits AtCompletionTotalCost Baseline1ActualTotalCost Baseline1ActualExpenseCost Baseline1ActualMaterialCost Baseline1ActualNonLaborCost Baseline1ActualLaborCost Baseline1ActualNonLaborUnits Baseline1ActualLaborUnits Baseline1PlannedExpenseCost Baseline1PlannedLaborCost Baseline1PlannedLaborUnits Baseline1PlannedMaterialCost Baseline1PlannedNonLaborCost Baseline1PlannedNonLaborUnits Baseline1PlannedTotalCost BaselineActualExpenseCost BaselineActualLaborCost BaselineActualLaborUnits BaselineActualMaterialCost BaselineActualNonLaborCost BaselineActualNonLaborUnits BaselineActualTotalCost 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 CumulativeActualCost CumulativeActualExpenseCost CumulativeActualLaborCost CumulativeActualLaborUnits CumulativeActualMaterialCost CumulativeActualNonLaborCost CumulativeActualNonLaborUnits CumulativeActualTotalCost CumulativeAtCompletionExpenseCost CumulativeAtCompletionLaborCost CumulativeAtCompletionLaborUnits CumulativeAtCompletionMaterialCost CumulativeAtCompletionNonLaborCost CumulativeAtCompletionNonLaborUnits CumulativeAtCompletionTotalCost CumulativeBaseline1ActualTotalCost CumulativeBaseline1ActualExpenseCost CumulativeBaseline1ActualMaterialCost CumulativeBaseline1ActualNonLaborCost CumulativeBaseline1ActualLaborCost CumulativeBaseline1ActualNonLaborUnits CumulativeBaseline1ActualLaborUnits CumulativeBaseline1PlannedExpenseCost CumulativeBaseline1PlannedLaborCost CumulativeBaseline1PlannedLaborUnits CumulativeBaseline1PlannedMaterialCost CumulativeBaseline1PlannedNonLaborCost CumulativeBaseline1PlannedNonLaborUnits CumulativeBaseline1PlannedTotalCost CumulativeBaselineActualExpenseCost CumulativeBaselineActualLaborCost CumulativeBaselineActualLaborUnits CumulativeBaselineActualMaterialCost CumulativeBaselineActualNonLaborCost CumulativeBaselineActualNonLaborUnits CumulativeBaselineActualTotalCost 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 ActivitySpreadPeriods that contain the live activity spread data for the period. Contains StartDate, EndDate, and one or more instances of the following data:

Last Published Wednesday, February 1, 2023