View an Activity Aggregate by Project
get
/primeapi/restapi/activityAggregate/projects?id={id}
This endpoint returns activity aggregates that meet the following requirements:
- The object is associated with a project with an ID value that matches one of the values of the {id} query parameter.
Request
Query Parameters
-
id: string
One or more system-generated identifiers of projects.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityActivityAggregate
Type:
Show Source
object
-
accountingVarianceLaborUnits(optional):
object Unit
-
activityAggregateConfiguredFields(optional):
object ApiEntityActivityAggregateConfiguredFields
-
activityPercentComplete(optional):
object Percent
-
actualDuration(optional):
object Duration
-
actualFinish(optional):
string(date-time)
The date when the activity was completed.
-
actualLaborUnits(optional):
object Unit
-
actualNonLaborUnits(optional):
object Unit
-
actualStart(optional):
string(date-time)
The date work on the activity began.
-
actualThisPeriodLaborUnits(optional):
object Unit
-
actualThisPeriodNonLaborUnits(optional):
object Unit
-
aggregateId(optional):
integer(int64)
The unique identifier of a rollup.
-
atCompletionDuration(optional):
object Duration
-
atCompletionLaborUnits(optional):
object Unit
-
atCompletionNonLaborUnits(optional):
object Unit
-
baselineDuration(optional):
object Duration
-
baselineFinishDate(optional):
string(date-time)
Current finish date for the activity in the project baseline.
-
baselinePlannedLaborUnits(optional):
object Unit
-
baselinePlannedNonLaborUnits(optional):
object Unit
-
baselineStartDate(optional):
string(date-time)
Current start date of the activity in the project baseline.
-
completedWeight(optional):
number(double)
The method used for calculating the scope percentage of completed items.
-
constraintDate(optional):
string(date-time)
Constraint date for the activity.
-
durationPercentComplete(optional):
object Percent
-
durationPercentOfPlanned(optional):
object Percent
-
earlyFinish(optional):
string(date-time)
The earliest possible date the remaining work for the activity can begin.
-
earlyStart(optional):
string(date-time)
The earliest possible date the remaining work for the activity can begin.
-
earnedValueLaborUnits(optional):
object Unit
-
estimateAtCompletionLaborUnits(optional):
object Unit
-
estimateToCompletionLaborUnits(optional):
object Unit
-
expectedFinish(optional):
string(date-time)
The date work on the activity is expected to end.
-
finishDate(optional):
string(date-time)
The current finish date for the activity.
-
floatPath(optional):
integer(int64)
Indicates which critical path the activity is on. An activity with a float path value of 1 is on the most critical path. Higher values indicate less critical paths.
-
floatPathOrder(optional):
integer(int64)
The position of the activity on its critical path.
-
freeFloat(optional):
number(double)
Amount of time the activity can be delayed before delaying the start date of any successor activity.
-
laborUnitsCompletePercent(optional):
object Percent
-
lateFinish(optional):
string(date-time)
The latest possible date the activity can finish without delaying the project finish date.
-
lateStart(optional):
string(date-time)
The latest possible date the remaining work for the activity can begin without delaying the project finish date.
-
link(optional):
string(url)
Read Only:
true
-
nonLaborUnitsCompletePercent(optional):
object Percent
-
performancePercentComplete(optional):
object Percent
-
physicalPercentComplete(optional):
object Percent
-
plannedDuration(optional):
object Duration
-
plannedFinish(optional):
string(date-time)
The date the activity is scheduled to end if the activity has not started.
-
plannedLaborUnits(optional):
object Unit
-
plannedNonLaborUnits(optional):
object Unit
-
plannedStart(optional):
string(date-time)
The date the activity is scheduled to begin.
-
plannedValueLaborUnits(optional):
object Unit
-
primaryKey(optional):
integer(int64)
-
recordCount(optional):
integer(int32)
The number of activities added to a project.
-
referenceObjectId(optional):
integer(int64)
The unique identifier of an activity reference object.
-
remainingDuration(optional):
object Duration
-
remainingFinish(optional):
string(date-time)
The date the remaining work for the activity is scheduled to end.
-
remainingLaborUnits(optional):
object Unit
-
remainingLateFinish(optional):
string(date-time)
The latest possible date the activity must finish without delaying the project finish date.
-
remainingLateStart(optional):
string(date-time)
The latest possible date the remaining work for the activity must begin without delaying the project finish date.
-
remainingNonLaborUnits(optional):
object Unit
-
remainingStart(optional):
string(date-time)
The date the remaining work for the activity is scheduled to begin.
-
resumeDate(optional):
string(date-time)
The date when a suspended task or activity is resumed.
-
rollupType(optional):
string
Allowed Values:
[ "ACTIVITY_TO_WORK_PACKAGE", "ACTIVITY_TO_WBS", "ACTIVITY_TO_PROJECT", "ACTIVITY_TO_PRIMARY_RESOURCE", "ACTIVITY_TO_SUMMARY_ACTIVITY", "ACTIVITY_TO_ACTIVITY_CODE" ]
The type of rollup. -
schedulePercentComplete(optional):
object Percent
-
schedulePerfIndexLaborUnits(optional):
object Unit
-
scheduleVarianceLaborUnits(optional):
object Unit
-
scheduleVarIndexLaborUnits(optional):
object Unit
-
secondaryConstraintDate(optional):
string(date-time)
The date for the activity's secondary constraint, if the activity has a secondary constraint.
-
startDate(optional):
string(date-time)
The current start date of the activity. If the activity is started, this value is the activity actual start date. If the activity is not started, this value is the activity planned start date.
-
suspendDate(optional):
string(date-time)
The date work temporarily stopped on an activity.
-
totalFloat(optional):
number(double)
Amount of time the activity can be delayed before delaying the project finish date. Calculated as late start minus early start or as late finish minus early finish.
-
uniqueName(optional):
string
-
unitsPercentComplete(optional):
object Percent
-
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. -
varDuration(optional):
object Percent
-
varFinishDate(optional):
object Duration
-
varianceAtCompletionLaborUnits(optional):
object Unit
-
varLaborUnits(optional):
object Unit
-
varNonLaborUnits(optional):
object Unit
-
varStartDate(optional):
object Duration
-
weight(optional):
number(double)
The importance of the activity in relation to other activities.
Nested Schema : Unit
Type:
object
Nested Schema : ApiEntityActivityAggregateConfiguredFields
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 an activity reference 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 : 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
204 Response
Successful operation with no content.
404 Response
The requested activity aggregate does not exist, or you do not have access to it.