ReadCBSResourceSpread Operation

Description: Reads the summarized CBS spreads of the specified Project Resources

Service: Spread Service

Style: Document/literal wrapped

Input:

Message: ReadCBSResourceSpread

Elements:

Field	Type	Description
ProjectObjectId	int	The unique identifier for the project. Specify zero to many 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.
BaselineIds	string
SummaryDateField	CBSRsrcSummaryFieldType string restricted to SummaryActualFinish SummaryActualStart SummaryPlannedFinish SummaryPlannedStart SummaryRemainingFinish SummaryRemainingStart	The summary date you want to include in the spread. Specify one to many SummaryDateField elements.
SpreadField	CBSRsrcExpenseSpreadFieldType string restricted to ActualCost ActualUnits AtCompletionCost AtCompletionUnits PlannedCost PlannedUnits RemainingCost RemainingUnits	The fields you want to include in the spread. Specify one to many SpreadField elements.

Output:

Message: ReadCBSResourceSpreadResponse

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

Field	Type	Description
BaselineProjectObjectId	int	The unique identifier of the baseline project. The BaselineProjectObjectId equals the TargetProjectObjectId passed in as an input parameter.
ProjectObjectId	int	The unique identifier of the project object.
ProjectId	string	The unique identifier of the project.
ProjectName	string	The name of the project.
OriginalProjectObjectId	int	The unique identifier of the project from which the project baseline was created, if the current project is a project baseline.
CBSObjectId	int	The unique identifier of the CBS object.
ResourceObjectId	int	The unique identifier of the Resource object.
BaselineType	string	The baseline type you want to use in the spread.
DataDate	string	The current data date for the project.
ResourceId	string	The unique identifier of the resource.
ResourceName	string	The name of the resource.
ResourceType	string	The resource type.
UnitName	string	The unit you want to use in the spread.
UnitAbbreviation	string	The abbreviation of the unit you want to use in the spread.
CurrencyId	string	The unique identifier of the currency.
CurrencyName	string	The name of the currency.
SummaryActualCost	double	The Actual Cost.
SummaryActualUnit	double	The Actual Units.
SummaryAtCompletionCost	double	The At Completion Cost.
SummaryAtCompletionUnits	double	The At Completion Units.
SummaryPlannedCost	double	The Planned Cost.
SummaryPlannedUnits	double	The Planned Units.
SummaryRemainingCost	double	The Remaining Costs.
SummaryRemainingUnits	double	The Remaining Units.
SummaryActualFinish	dateTime	The Actual Finish date.
SummaryActualStart	dateTime	The Actual Start date.
SummaryPlannedFinish	dateTime	The Planned Finish date.
SummaryPlannedStart	dateTime	The Planned Start date.
SummaryRemainingFinish	dateTime	The date the project is scheduled to finish the remaining work.
SummaryRemainingStart	dateTime	The earliest remaining start of all activities.
StartDate	dateTime	The start date of the spread.
EndDate	dateTime	The end date of the spread.
PeriodType	SummarizedSpreadPeriodType string restricted to Week Month Quarter Year Financial Period Day	Spread period type enumerations are used to specify the spread interval for CBS.
Period	CBSRsrcExpenseSpreadPeriod	The field type of the spread.

Last Published Wednesday, February 1, 2023