Description: Reads the spreads of the specified role assignments to the activities from the specified projects.
Service: Spread Service
Style: Document/literal wrapped
Input:
Message: ReadProjectRoleSpread
Elements:
Field
| Type
| Description
|
---|
ProjectObjectId
| int
| The unique identifier for the project.
You can specify zero or more ProjectObjectIds.
|
RoleObjectId
| int
| The unique identifier of the associated role.
You can specify zero or more RoleObjectIds.
|
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
| ResourceRoleSpreadFieldType
string restricted to ActualCost ActualOvertimeCost ActualOvertimeUnits ActualRegularCost ActualRegularUnits ActualUnits AtCompletionCost AtCompletionUnits Limit PeriodActualCost PeriodActualUnits PeriodAtCompletionCost PeriodAtCompletionUnits PlannedCost PlannedUnits RemainingCost RemainingLateCost RemainingLateUnits RemainingUnits StaffedActualCost StaffedActualOvertimeCost StaffedActualOvertimeUnits StaffedActualRegularCost StaffedActualRegularUnits StaffedActualUnits StaffedAtCompletionCost StaffedAtCompletionUnits StaffedPlannedCost StaffedPlannedUnits StaffedRemainingCost StaffedRemainingLateCost StaffedRemainingLateUnits StaffedRemainingUnits UnstaffedActualCost UnstaffedActualOvertimeCost UnstaffedActualOvertimeUnits UnstaffedActualRegularCost UnstaffedActualRegularUnits UnstaffedActualUnits UnstaffedAtCompletionCost UnstaffedAtCompletionUnits UnstaffedPlannedCost UnstaffedPlannedUnits UnstaffedRemainingCost UnstaffedRemainingLateCost UnstaffedRemainingLateUnits UnstaffedRemainingUnits
| The fields you want to include in the spread. Specify one to many SpreadField elements.
|
Output:
Message: ReadProjectRoleSpreadResponse
Elements: One to many ProjectRoleSpread elements that contain the following fields:
Field
| Type
| Description
|
---|
ProjectId
| string
| The short code that uniquely identifies the project.
|
ProjectObjectId
| int
| The unique identifier of the project.
|
RoleId
| string
| The short code that uniquely identifies the role.
|
RoleObjectId
| int
| The unique identifier of the role.
|
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
| ResourceRoleSpreadPeriod
StartDate EndDate FinancialPeriodObjectId ActualCost ActualOvertimeCost ActualOvertimeUnits ActualRegularCost ActualRegularUnits ActualUnits AtCompletionCost AtCompletionUnits Limit PeriodActualCost PeriodActualUnits PeriodAtCompletionCost PeriodAtCompletionUnits PlannedCost PlannedUnits RemainingCost RemainingLateCost RemainingLateUnits RemainingUnits StaffedActualCost StaffedActualOvertimeCost StaffedActualOvertimeUnits StaffedActualRegularCost StaffedActualRegularUnits StaffedActualUnits StaffedAtCompletionCost StaffedAtCompletionUnits StaffedPlannedCost StaffedPlannedUnits StaffedRemainingCost StaffedRemainingLateCost StaffedRemainingLateUnits StaffedRemainingUnits UnstaffedActualCost UnstaffedActualOvertimeCost UnstaffedActualOvertimeUnits UnstaffedActualRegularCost UnstaffedActualRegularUnits UnstaffedActualUnits UnstaffedAtCompletionCost UnstaffedAtCompletionUnits UnstaffedPlannedCost UnstaffedPlannedUnits UnstaffedRemainingCost UnstaffedRemainingLateCost UnstaffedRemainingLateUnits UnstaffedRemainingUnits CumulativeActualCost CumulativeActualOvertimeCost CumulativeActualOvertimeUnits CumulativeActualRegularCost CumulativeActualRegularUnits CumulativeActualUnits CumulativeAtCompletionCost CumulativeAtCompletionUnits CumulativeLimit CumulativePeriodActualCost CumulativePeriodActualUnits CumulativePeriodAtCompletionCost CumulativePeriodAtCompletionUnits CumulativePlannedCost CumulativePlannedUnits CumulativeRemainingCost CumulativeRemainingLateCost CumulativeRemainingLateUnits CumulativeRemainingUnits CumulativeStaffedActualCost CumulativeStaffedActualOvertimeCost CumulativeStaffedActualOvertimeUnits CumulativeStaffedActualRegularCost CumulativeStaffedActualRegularUnits CumulativeStaffedActualUnits CumulativeStaffedAtCompletionCost CumulativeStaffedAtCompletionUnits CumulativeStaffedPlannedCost CumulativeStaffedPlannedUnits CumulativeStaffedRemainingCost CumulativeStaffedRemainingLateCost CumulativeStaffedRemainingLateUnits CumulativeStaffedRemainingUnits CumulativeUnstaffedActualCost CumulativeUnstaffedActualOvertimeCost CumulativeUnstaffedActualOvertimeUnits CumulativeUnstaffedActualRegularCost CumulativeUnstaffedActualRegularUnits CumulativeUnstaffedActualUnits CumulativeUnstaffedAtCompletionCost CumulativeUnstaffedAtCompletionUnits CumulativeUnstaffedPlannedCost CumulativeUnstaffedPlannedUnits CumulativeUnstaffedRemainingCost CumulativeUnstaffedRemainingLateCost CumulativeUnstaffedRemainingLateUnits CumulativeUnstaffedRemainingUnits
| One or more ResourceRoleSpreadPeriod elements that contain the live activity spread data for the period.
Contains the StartDate, EndDate, and one or more instances of the following data:
|