View Scope Item Aggregates by Project
get
/primeapi/restapi/scopeItemAggregate/project/{projectId}
This endpoint returns scope item aggregates that meet the following requirements:
- The object has a project with an ID value that matches the value of the {projectId} path parameter.
Request
Path Parameters
-
projectId: integer(int64)
The system-generated identifier of a project.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityScopeItemAggregate
Type:
Show Source
object
-
aggregateId:
integer(int64)
The unique identifier of a rollup.
-
approvedChangedHours(optional):
object Hour
-
approvedChangedUnits(optional):
object Quantity
-
assignedHours(optional):
object Hour
-
assignedUnits(optional):
object Quantity
-
baselineHours(optional):
object Hour
-
baselineUnits(optional):
object Quantity
-
effectiveFinish(optional):
string(date-time)
The latest effective finish date for actual to date values of all the scope item's scope assignments.
-
effectiveStart(optional):
string(date-time)
The earliest effective start date for actual to date values of all the scope item's scope assignments.
-
link(optional):
string(url)
Read Only:
true
-
pendingChangedHours(optional):
object Hour
-
pendingChangedUnits(optional):
object Quantity
-
plannedHours(optional):
object Hour
-
plannedHoursPerUnit(optional):
number(double)
Number of hours required to install or assemble a single quantity of the scope item material or product. Calculated as original hours divided by original quantity.
-
plannedUnits(optional):
object Quantity
-
referenceObjectId:
integer(int64)
The unique identifier of a scope item reference object.
-
revisedHours(optional):
object Hour
-
revisedUnits(optional):
object Quantity
-
rollupType:
string
Allowed Values:
[ "SCOPE_ITEM_TO_PROJECT" ]
The type of rollup. -
scopeItemAggregateConfiguredFields(optional):
object ApiEntityScopeItemAggregateConfiguredFields
-
unAssignedHours(optional):
object Hour
-
unAssignedUnits(optional):
object Quantity
-
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 : Quantity
Type:
object
Nested Schema : ApiEntityScopeItemAggregateConfiguredFields
Type:
Show Source
object
-
aggregateId:
integer(int64)
The unique identifier of a rollup.
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with a scope item aggregate.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesThe non-cost and non-text fields associated with a scope item aggregate.
-
referenceObjectId:
integer(int64)
The unique identifier of a scope item reference object.
-
rollupType:
string
Allowed Values:
[ "SCOPE_ITEM_TO_PROJECT" ]
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 : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with a scope item aggregate.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
The non-cost and non-text fields associated with a scope item aggregate.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
204 Response
Successful operation with no content.
404 Response
The requested scope item aggregates do not exist, or you do not have access to them.