View a Work Package Aggregate by Reference
get
/primeapi/restapi/workPackageAggregate/reference/{id}?rollupType={rollupType}
This endpoint returns work package aggregates that meet the following requirements:
- The object has a reference to another object with an ID value that matches the value of the {id} path parameter.
Request
Path Parameters
-
id: integer(int64)
The system-generated identifier of an object reference.
Query Parameters
-
rollupType: string
Rollup type.Allowed Values:
[ "WORK_PACKAGE_TO_WBS", "WORK_PACKAGE_TO_PROJECT" ]
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityWorkPackageAggregate
Type:
Show Source
object
-
activityPercentComplete(optional):
object Percent
-
aggregateId(optional):
integer(int64)
The unique identifier of a rollup.
-
baselineFinishDate(optional):
string(date-time)
The planned finish date for the work package as is set in the current baseline. This field is populated with the revised finish date at the time that the current baseline is set.
-
baselineStartDate(optional):
string(date-time)
The planned start date for the work package as is set in the current baseline. This field is populated with the revised start date at the time that the current baseline is set.
-
eacWithSpendsHours(optional):
object Hour
-
earnedPercentComplete(optional):
object Percent
-
installedFinishDate(optional):
string(date-time)
The date work on the work package ended.
-
installedStartDate(optional):
string(date-time)
The date work on the work package began.
-
link(optional):
string(url)
Read Only:
true
-
percentComplete(optional):
object Percent
-
plannedFinishDate(optional):
string(date-time)
The date work on the work package is scheduled to end.
-
plannedStartDate(optional):
string(date-time)
The date work on the work package is scheduled to begin.
-
referenceObjectId(optional):
integer(int64)
The unique identifier of a work package reference.
-
remainingEarlyFinishDate(optional):
string(date-time)
The earliest date work on the work package is scheduled to end.
-
remainingEarlyStartDate(optional):
string(date-time)
The earliest date work on the work package is scheduled to begin.
-
remainingLateFinishDate(optional):
string(date-time)
The latest possible date work on the work package must finish to not delay the finish date.
-
remainingLateStartDate(optional):
string(date-time)
The latest possible date work on the work package must begin without delaying the finish date.
-
rollupType(optional):
string
Allowed Values:
[ "WORK_PACKAGE_TO_WBS", "WORK_PACKAGE_TO_PROJECT" ]
The type of rollup. -
spendsHours(optional):
object Hour
-
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. -
workPackageAggregateConfiguredFields(optional):
object ApiEntityWorkPackageAggregateConfiguredFields
-
workPackageCostAggregate(optional):
object ApiEntityWorkPackageCostAggregate
Nested Schema : ApiEntityWorkPackageAggregateConfiguredFields
Type:
Show Source
object
-
aggregateId:
integer(int64)
The unique identifier of a rollup.
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesWork package aggregate cost configured field object.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesWork package aggregate other configured field object.
-
referenceObjectId:
integer(int64)
The unique identifier of a work package reference.
-
rollupType:
string
Allowed Values:
[ "WORK_PACKAGE_TO_WBS", "WORK_PACKAGE_TO_PROJECT" ]
The type of rollup. -
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesWork package aggregate text configured field object.
-
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 : ApiEntityWorkPackageCostAggregate
Type:
Show Source
object
-
aggregateId(optional):
integer(int64)
The unique identifier of a rollup.
-
eacWithSpendsCost(optional):
object Cost
-
link(optional):
string(url)
Read Only:
true
-
primaryKey(optional):
integer(int64)
-
referenceObjectId(optional):
integer(int64)
The unique identifier of a work package reference.
-
rollupType(optional):
string
Allowed Values:
[ "Length[1-60]" ]
The type of rollup. -
spendsCost(optional):
object Cost
-
uniqueName(optional):
string
-
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
Work package aggregate cost configured field object.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
Work package aggregate other configured field object.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
Work package aggregate text configured field object.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : Cost
Type:
object
204 Response
Successful operation with no content.
404 Response
The requested workpackage aggregate does not exist, or you do not have access to it.