View Scope Item Assignment Aggregates
get
/primeapi/restapi/scopeItemAssignmentAggregate/{id}
This endpoint returns scope item assignment aggregates that meet the following requirements:
- The object has an ID that matches the value of the {id} path parameter.
Request
Path Parameters
-
id: integer(int64)
The system-generated identifier of a scope item assignment aggregate.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityScopeItemAssignmentAggregate
Type:
Show Source
object
-
actualHoursToDate(optional):
object Hour
-
actualUnitsToDate(optional):
object Quantity
-
aggregateId:
integer(int64)
The unique identifier of a rollup.
-
approvedChangedHours(optional):
object Hour
-
approvedChangedUnits(optional):
object Quantity
-
atCompletionHours(optional):
object Hour
-
atCompletionUnits(optional):
object Quantity
-
availableHours(optional):
object Hour
-
availableUnits(optional):
object Quantity
-
bacHours(optional):
object Hour
-
bacUnits(optional):
object Quantity
-
baselineFinishDate(optional):
string(date-time)
The planned finish date for the work package as set in the current baseline. This field is used to spread baseline data fields.
-
baselineHours(optional):
object Hour
-
baselineStartDate(optional):
string(date-time)
The planned start date for the work package as set in the current baseline. This field is used to spread baseline data fields.
-
baselineUnits(optional):
object Quantity
-
currentHoursPerUnit(optional):
number(double)
The number of hours it will take to install or assemble the product of material per unit based on current values. Calculated as revised hours divided by revised quantity.
-
eacHours(optional):
object Hour
-
eacUnits(optional):
object Quantity
-
earnedHours(optional):
object Hour
-
earnedPercentComplete(optional):
object Percent
-
earnedUnits(optional):
object Quantity
-
effectiveDate(optional):
string(date-time)
The latest date of all actual to date and actual cost to date values for the scope assignment.
-
effectiveStartDate(optional):
string(date-time)
The earliest date of all actual hours to date and actual cost to date values for the scope assignment.
-
etcAdjustedHours(optional):
object Hour
-
etcAdjustedUnits(optional):
object Quantity
-
etcHours(optional):
object Hour
-
etcUnits(optional):
object Quantity
-
hoursPerUnit(optional):
number(double)
The original productivity rate of a work package.
-
installedFinishDate(optional):
string(date-time)
The date work on the work package completed.
-
installedHours(optional):
object Hour
-
installedStartDate(optional):
string(date-time)
The date work on the work package began.
-
installedUnits(optional):
object Quantity
-
link(optional):
string(url)
Read Only:
true
-
manualWeight(optional):
number(double)
Calculated as scope percent complete multiplied by manual weight factor.
-
manualWeightFactor(optional):
number(double)
The amount by which the manual weight is calculated when progress needs to be weighed against a factor other than quantity, hours, or cost.
-
milestoneProgressPercent(optional):
object Percent
-
originalFinishDate(optional):
string(date-time)
The date the work on the scope assignment in scheduled to end.
-
originalStartDate(optional):
string(date-time)
The date the work on the scope assignment is scheduled to begin.
-
pendingChangedHours(optional):
object Hour
-
pendingChangedUnits(optional):
object Quantity
-
percentComplete(optional):
object Percent
-
plannedFinishDate(optional):
string(date-time)
The date the work on the work package is scheduled to end.
-
plannedHours(optional):
object Hour
-
plannedStartDate(optional):
string(date-time)
The date the work on the work package is scheduled to begin.
-
plannedUnits(optional):
object Quantity
-
referenceObjectId:
integer(int64)
The unique identifier of a work package reference.
-
remainingEarlyFinishDate(optional):
string(date-time)
The earliest date the work on the work package is scheduled to end.
-
remainingEarlyStartDate(optional):
string(date-time)
The earliest date the work on the work package is scheduled to begin.
-
remainingHours(optional):
object Hour
-
remainingLateFinishDate(optional):
string(date-time)
The latest possible date work on the scope assignment must end not to delay the finish date.
-
remainingLateStartDate(optional):
string(date-time)
The latest possible date work on the scope assignment must begin without delaying the finish date.
-
remainingUnits(optional):
object Quantity
-
revisedFinishDate(optional):
string(date-time)
The revised finish date for the scope assignment.
-
revisedHours(optional):
object Hour
-
revisedStartDate(optional):
string(date-time)
The revised start date for the scope assignment.
-
revisedUnits(optional):
object Quantity
-
rollupType:
string
Allowed Values:
[ "SCOPE_TO_WORK_PACKAGE", "SCOPE_TO_WBS", "SCOPE_TO_PROJECT", "SCOPE_TO_SCOPE_ITEM" ]
The type of rollup. -
scopeItemAssignmentAggregateConfiguredFields(optional):
object ApiEntityScopeItemAssignmentAggregateConfiguredFields
-
scopeItemAssignmentCostAggregate(optional):
object ApiEntityScopeItemAssignmentCostAggregate
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
weightedCost(optional):
object Cost
-
weightedHours(optional):
object Hour
-
weightedUnits(optional):
object Quantity
Nested Schema : Quantity
Type:
object
Nested Schema : ApiEntityScopeItemAssignmentAggregateConfiguredFields
Type:
Show Source
object
-
aggregateId:
integer(int64)
The unique identifier of a rollup.
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost fields in the form of key-value pairs.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing non-cost and non-text fields in the form of key-value pairs.
-
referenceObjectId:
integer(int64)
The unique identifier of a work package reference.
-
rollupType:
string
Allowed Values:
[ "SCOPE_TO_WORK_PACKAGE", "SCOPE_TO_WBS", "SCOPE_TO_PROJECT", "SCOPE_TO_SCOPE_ITEM" ]
The type of rollup. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityScopeItemAssignmentCostAggregate
Type:
Show Source
object
-
actualCostToDate(optional):
object Cost
-
actualCostToDateProject(optional):
object Cost
-
adjustedCost(optional):
object Cost
-
adjustedCostProject(optional):
object Cost
-
aggregateId:
integer(int64)
The unique identifier of a rollup.
-
approvedChangedCost(optional):
object Cost
-
approvedChangedCostProject(optional):
object Cost
-
atCompletionCost(optional):
object Cost
-
atCompletionCostProject(optional):
object Cost
-
bacCost(optional):
object Cost
-
bacCostProject(optional):
object Cost
-
baselineCost(optional):
object Cost
-
baselineCostProject(optional):
object Cost
-
currentRate(optional):
object Cost
-
currentRateProject(optional):
object Cost
-
eacCost(optional):
object Cost
-
eacCostProject(optional):
object Cost
-
earnedCost(optional):
object Cost
-
earnedCostProject(optional):
object Cost
-
etcCost(optional):
object Cost
-
etcCostProject(optional):
object Cost
-
installedCost(optional):
object Cost
-
installedCostProject(optional):
object Cost
-
link(optional):
string(url)
Read Only:
true
-
pendingChangedCost(optional):
object Cost
-
pendingChangedCostProject(optional):
object Cost
-
plannedCost(optional):
object Cost
-
plannedCostProject(optional):
object Cost
-
rate(optional):
object Cost
-
rateProject(optional):
object Cost
-
referenceObjectId:
integer(int64)
The unique identifier of a work package reference.
-
remainingCost(optional):
object Cost
-
remainingCostProject(optional):
object Cost
-
revisedCost(optional):
object Cost
-
revisedCostProject(optional):
object Cost
-
rollupType:
string
Allowed Values:
[ "SCOPE_TO_WORK_PACKAGE", "SCOPE_TO_WBS", "SCOPE_TO_PROJECT", "SCOPE_TO_SCOPE_ITEM" ]
The type of rollup. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : Cost
Type:
object
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing cost fields in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing non-cost and non-text fields in the form of key-value pairs.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
404 Response
The requested scope item assignment aggregates do not exist, or you do not have access to them.