Description: Reads the live resource assignment spread data from the specified resource assignment.
Style: Document/literal wrapped
Input:
Message: ReadResourceAssignmentSpread
Elements:
Field
|
Type
|
Description
|
|---|
ResourceAssignmentObjectId
| int
| The unique identifier for the ResourceAssignment.
You can specify one or more ResourceAssignmentObjectId.
|
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
|
ResourceAssignmentSpreadFieldType
string
restricted to
ActualCost
ActualOvertimeCost
ActualOvertimeUnits
ActualRegularCost
ActualRegularUnits
ActualUnits
AtCompletionCost
AtCompletionUnits
PlannedCost
PlannedUnits
RemainingCost
RemainingLateCost
RemainingLateUnits
RemainingUnits
StaffedRemainingCost
StaffedRemainingLateCost
StaffedRemainingLateUnits
StaffedRemainingUnits
UnstaffedRemainingCost
UnstaffedRemainingLateCost
UnstaffedRemainingLateUnits
UnstaffedRemainingUnits
PeriodActualCost
PeriodActualUnits
PeriodAtCompletionCost
PeriodAtCompletionUnits
| The fields you want to include in the spread. Specify one to many SpreadField elements.
|
Output:
Message: ReadResourceAssignmentSpreadResponse
Elements: One to many ResourceAssignmentSpread elements that contain the following fields:
Field
|
Type
|
Description
|
|---|
ResourceAssignmentObjectId
| int
| The unique identifier of the ResourceAssignment.
|
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 EPS.
|
Period
|
ResourceAssignmentSpreadPeriod
StartDate
EndDate
ActualCost
ActualOvertimeCost
ActualOvertimeUnits
ActualRegularCost
ActualRegularUnits
ActualUnits
AtCompletionCost
AtCompletionUnits
PlannedCost
PlannedUnits
RemainingCost
RemainingLateCost
RemainingLateUnits
RemainingUnits
StaffedRemainingCost
StaffedRemainingLateCost
StaffedRemainingLateUnits
StaffedRemainingUnits
UnstaffedRemainingCost
UnstaffedRemainingLateCost
UnstaffedRemainingLateUnits
UnstaffedRemainingUnits
CumulativeActualCost
CumulativeActualOvertimeCost
CumulativeActualOvertimeUnits
CumulativeActualRegularCost
CumulativeActualRegularUnits
CumulativeActualUnits
CumulativeAtCompletionCost
CumulativeAtCompletionUnits
CumulativePlannedCost
CumulativePlannedUnits
CumulativeRemainingCost
CumulativeRemainingLateCost
CumulativeRemainingLateUnits
CumulativeRemainingUnits
CumulativeStaffedRemainingCost
CumulativeStaffedRemainingLateCost
CumulativeStaffedRemainingLateUnits
CumulativeStaffedRemainingUnits
CumulativeUnstaffedRemainingCost
CumulativeUnstaffedRemainingLateCost
CumulativeUnstaffedRemainingLateUnits
CumulativeUnstaffedRemainingUnits
| One or more ResourceAssignmentSpreadPeriods that contain the live activity spread data for the period.
Contains the StartDate, EndDate, and one or more instances of the following data:
|