Jump to

• Request
• Response

View a Work Package Activity Aggregate by Projects

get

/api/restapi/activityAggregate/workPackage/project

This endpoint returns work package 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.

Activity aggregates sum the data of activities that meet specified requirements.

Request

Query Parameters

• id(required): integer(int64)
  The system-generated identifier of a project.
  This is a required field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityActivityAggregate>

Type: array

Title: List<ApiEntityActivityAggregate>

Show Source

• Array of: object ApiEntityActivityAggregate
  Title: ApiEntityActivityAggregate

{
    "title":"List<ApiEntityActivityAggregate>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityActivityAggregate",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityActivityAggregate

Type: object

Title: ApiEntityActivityAggregate

Show Source

• accountingVarianceLaborUnits: integer (int64)
  The difference between the planned value of work scheduled and the actual work performed.
• activityAggregateId: integer (int64)
  The unique identifier of a rollup.
• actualDuration: number (double)
  Total working time from the activity actual start date to the actual finish date for completed activities, or the total working time from the actual start date to the data date for in progress activities.
• actualFinish: string (date-time)
  The date when the activity was completed.
• actualLaborUnits: integer (int64)
  Number of units expended for all labor resources assigned to an activity.
• actualNonLaborUnits: integer (int64)
  Number of nonlabor units that have been expended on the activity.
• actualStart: string (date-time)
  The date work on the activity began.
• actualThisPeriodLaborUnits: integer (int64)
  The number of labor units used during this financial period.
• actualThisPeriodNonLaborUnits: integer (int64)
  The number of nonlabor units used during this financial period.
• atCompletionDuration: number (double)
  Total working time from the activity's current start date to the current finish date. If the activity is not started, the current start date is the activity planned start date and the current finish date is the activity planned finish date. If the activity is started, the current start date is the activity actual start date and the current finish date is either the activity remaining finish date or actual finish date.
• atCompletionLaborUnits: integer (int64)
  The sum of the actual plus remaining units for all labor resources assigned to the activity. If the activity is not started, this value is equal to the activity planned labor units. If the activity is completed, this value is equal to the activity actual labor units. Calculated as actual labor units plus remaining labor units. This field is non editable for 'START_MILESTONE', 'FINISH_MILESTONE' type activities.
• atCompletionNonLaborUnits: integer (int64)
  The sum of the actual plus remaining units for all nonlabor resources assigned to the activity. If the activity is not started, this value is equal to the activity planned nonlabor units. If the activity is completed, this value is equal to the activity actual nonlabor units. Calculated as actual nonlabor units and remaining nonlabor units. This field is non editable for 'START_MILESTONE', 'FINISH_MILESTONE' type activities.
• baselineDuration: number (double)
  Total number of hours allotted to the activity in the project baseline.
• baselineFinishDate: string (date-time)
  Current finish date for the activity in the project baseline.
• baselinePlannedLaborUnits: integer (int64)
  The planned number of units for all labor resources assigned to the activity in the project baseline.
• baselinePlannedNonLaborUnits: integer (int64)
  The planned units for all nonlabor resources assigned to the activities in the project baseline.
• baselineStartDate: string (date-time)
  Current start date of the activity in the project baseline.
• completedWeight: number (double)
  The method used for calculating the scope percentage of completed items.
• constraintDate: string (date-time)
  Constraint date for the activity.
• earlyFinish: string (date-time)
  The earliest possible date the remaining work for the activity can begin.
• earlyStart: string (date-time)
  The earliest possible date the remaining work for the activity can begin.
• earnedValueLaborUnits: integer (int64)
  The portion of baseline labor units that are complete as of the project data value.
• estimateAtCompletionLaborUnits: integer (int64)
  The estimated labor units at completion of the activity. Calculated as actual labor units plus estimated to completion labor units.
• estimateToCompletionLaborUnits: integer (int64)
  The estimated quantity to complete the activity.
• expectedFinish: string (date-time)
  The date work on the activity is expected to end.
• finishDate: string (date-time)
  The current finish date for the activity.
• floatPath: 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: integer (int64)
  The position of the activity on its critical path.
• freeFloat: number (double)
  Amount of time the activity can be delayed before delaying the start date of any successor activity.
• lateFinish: string (date-time)
  The latest possible date the activity can finish without delaying the project finish date.
• lateStart: string (date-time)
  The latest possible date the remaining work for the activity can begin without delaying the project finish date.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• plannedDuration: number (double)
  Expected amount of time required to complete an activity. Calculated using the activity's calendar. The duration is measured from the activity's planned start date to its planned finish date.
• plannedFinish: string (date-time)
  The date the activity is scheduled to end if the activity has not started. It is calculated by the scheduler and will not change after the activity has started.
• plannedLaborUnits: integer (int64)
  Planned number of units for all labor resources assigned to the activity.
• plannedNonLaborUnits: integer (int64)
  Planned units for all nonlabor resources assigned to the activity.
• plannedStart: string (date-time)
  The date the activity is scheduled to begin.
• plannedValueLaborUnits: integer (int64)
  The portion of baseline labor units that are scheduled to be complete as of the project data date.
• recordCount: integer (int32)
  The number of activities added to a project.
• referenceObjectId: integer (int64)
  The unique identifier of an activity reference object.
• remainingDuration: number (double)
  Total working time from the activity remaining start date to the remaining finish date.
• remainingFinish: string (date-time)
  The date the remaining work for the activity is scheduled to end.
• remainingLaborUnits: integer (int64)
  Remaining units for all labor resources assigned to an activity. Reflects the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.
• remainingLateFinish: string (date-time)
  The latest possible date the activity must finish without delaying the project finish date.
• remainingLateStart: string (date-time)
  The latest possible date the remaining work for the activity must begin without delaying the project finish date.
• remainingNonLaborUnits: integer (int64)
  Remaining units for all nonlabor resources assigned to the activity. Reflects the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed there are zero remaining units.
• remainingStart: string (date-time)
  The date the remaining work for the activity is scheduled to begin.
• resumeDate: string (date-time)
  The date when a suspended task or activity is resumed.
• rollupType: string
  Allowed Values: [ "ACTIVITY_TO_WORK_PACKAGE", "ACTIVITY_TO_PROJECT" ]

  The type of rollup.
• schedulePerfIndexLaborUnits: number (double)
  The ratio of the earned value of labor units to the planned value of labor units. Calculated as earned value labor units divided by planned value labor units.
• scheduleVarianceLaborUnits: integer (int64)
  The difference between the earned value of work performed and the work scheduled to be performed. Calculated as earned value labor units minus planned value labor units.
• scheduleVarIndexLaborUnits: number (double)
  The ratio of schedule variance labor units and the planned value labor units. Calculated as schedule variance labor units divided by planned value labor units.
• secondaryConstraintDate: string (date-time)
  The date for the activity's secondary constraint, if the activity has a secondary constraint.
• startDate: 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: string (date-time)
  The date work temporarily stopped on an activity.
• totalFloat: 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.
• updateDate: string (date-time)
  Date when the record was last updated.
• varFinishDate: number (double)
  The duration between the current project finish date and the baseline project finish date.
• varianceAtCompletionLaborUnits: integer (int64)
  The difference between the baseline planned total labor units and the estimate at completion labour units. Calculated as project baseline total labor units minus estimate at completion labor units.
• varLaborUnits: integer (int64)
  The difference between baseline labor units and at completion labor units.
• varNonLaborUnits: integer (int64)
  The difference between the baseline nonlabor units and the at completion nonlabor units.
• varStartDate: number (double)
  The duration between the current project start date and the baseline start date.
• weight: number (double)
  The importance of the activity in relation to other activities.

{
    "title":"ApiEntityActivityAggregate",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "constraintDate":{
            "type":"string",
            "description":"Constraint date for the activity.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingDuration":{
            "type":"number",
            "description":"Total working time from the activity remaining start date to the remaining finish date.",
            "format":"double",
            "exampleSetFlag":false
        },
        "suspendDate":{
            "type":"string",
            "description":"The date work temporarily stopped on an activity.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resumeDate":{
            "type":"string",
            "description":"The date when a suspended task or activity is resumed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "secondaryConstraintDate":{
            "type":"string",
            "description":"The date for the activity's secondary constraint, if the activity has a secondary constraint.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualDuration":{
            "type":"number",
            "description":"Total working time from the activity <b>actual start</b> date to the <b>actual finish</b> date for completed activities, or the total working time from the <b>actual start</b> date to the data date for in progress activities.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedDuration":{
            "type":"number",
            "description":"Expected amount of time required to complete an activity. Calculated using the activity's calendar. The duration is measured from the activity's planned start date to its planned finish date.",
            "format":"double",
            "exampleSetFlag":false
        },
        "startDate":{
            "type":"string",
            "description":"The current start date of the activity. If the activity is started, this value is the activity <b>actual start date</b>. If the activity is not started, this value is the activity <b>planned start date</b>. ",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finishDate":{
            "type":"string",
            "description":"The current finish date for the activity.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "atCompletionDuration":{
            "type":"number",
            "description":"Total working time from the activity's current start date to the current finish date. If the activity is not started, the current start date is the activity <b>planned start date</b> and the current finish date is the activity <b>planned finish date</b>. If the activity is started, the current start date is the activity <b>actual start date</b> and the current finish date is either the activity <b>remaining finish date</b> or <b>actual finish date</b>.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionLaborUnits":{
            "type":"integer",
            "description":"The sum of the actual plus remaining units for all labor resources assigned to the activity. If the activity is not started, this value is equal to the activity <b>planned labor units</b>. If the activity is completed, this value is equal to the activity <b>actual labor units</b>. Calculated as <b>actual labor units</b> plus <b>remaining labor units</b>. This field is non editable for 'START_MILESTONE', 'FINISH_MILESTONE' type activities.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "weight":{
            "type":"number",
            "description":"The importance of the activity in relation to other activities.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "completedWeight":{
            "type":"number",
            "description":"The method used for calculating the scope percentage of completed items.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "recordCount":{
            "type":"integer",
            "description":"The number of activities added to a project.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "freeFloat":{
            "type":"number",
            "description":"Amount of time the activity can be delayed before delaying the start date of any successor activity.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "totalFloat":{
            "type":"number",
            "description":"Amount of time the activity can be delayed before delaying the project finish date. Calculated as <b>late start</b> minus <b>early start</b> or as <b>late finish</b> minus <b>early finish</b>.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "plannedLaborUnits":{
            "type":"integer",
            "description":"Planned number of units for all labor resources assigned to the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "plannedNonLaborUnits":{
            "type":"integer",
            "description":"Planned units for all nonlabor resources assigned to the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "remainingLaborUnits":{
            "type":"integer",
            "description":"Remaining units for all labor resources assigned to an activity. Reflects the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "remainingNonLaborUnits":{
            "type":"integer",
            "description":"Remaining units for all nonlabor resources assigned to the activity. Reflects the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed there are zero remaining units.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "schedulePerfIndexLaborUnits":{
            "type":"number",
            "description":"The ratio of the earned value of labor units to the planned value of labor units. Calculated as <b>earned value labor units</b> divided by <b>planned value labor units</b>.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "scheduleVarIndexLaborUnits":{
            "type":"number",
            "description":"The ratio of schedule variance labor units and the planned value labor units. Calculated as <b>schedule variance labor units</b> divided by <b>planned value labor units</b>. ",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "actualLaborUnits":{
            "type":"integer",
            "description":"Number of units expended for all labor resources assigned to an activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "actualNonLaborUnits":{
            "type":"integer",
            "description":"Number of nonlabor units that have been expended on the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "atCompletionNonLaborUnits":{
            "type":"integer",
            "description":"The sum of the actual plus remaining units for all nonlabor resources assigned to the activity. If the activity is not started, this value is equal to the activity <b>planned nonlabor units</b>. If the activity is completed, this value is equal to the activity <b>actual nonlabor units</b>. Calculated as <b>actual nonlabor units</b> and <b>remaining nonlabor units</b>. This field is non editable for 'START_MILESTONE', 'FINISH_MILESTONE' type activities.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "earnedValueLaborUnits":{
            "type":"integer",
            "description":"The portion of baseline labor units that are complete as of the project data value.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "actualThisPeriodLaborUnits":{
            "type":"integer",
            "description":"The number of labor units used during this financial period.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "actualThisPeriodNonLaborUnits":{
            "type":"integer",
            "description":"The number of nonlabor units used during this financial period.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "varLaborUnits":{
            "type":"integer",
            "description":"The difference between baseline labor units and at completion labor units.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "varStartDate":{
            "type":"number",
            "description":"The duration between the current project start date and the baseline start date.",
            "format":"double",
            "exampleSetFlag":false
        },
        "accountingVarianceLaborUnits":{
            "type":"integer",
            "description":"The difference between the planned value of work scheduled and the actual work performed.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "scheduleVarianceLaborUnits":{
            "type":"integer",
            "description":"The difference between the earned value of work performed and the work scheduled to be performed. Calculated as <b>earned value labor units</b> minus <b>planned value labor units</b>.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "estimateToCompletionLaborUnits":{
            "type":"integer",
            "description":"The estimated quantity to complete the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "varFinishDate":{
            "type":"number",
            "description":"The duration between the current project finish date and the baseline project finish date.",
            "format":"double",
            "exampleSetFlag":false
        },
        "varNonLaborUnits":{
            "type":"integer",
            "description":"The difference between the baseline nonlabor units and the at completion nonlabor units.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "varianceAtCompletionLaborUnits":{
            "type":"integer",
            "description":"The difference between the baseline planned total labor units and the estimate at completion labour units. Calculated as <b>project baseline total labor units</b> minus <b>estimate at completion labor units</b>.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "estimateAtCompletionLaborUnits":{
            "type":"integer",
            "description":"The estimated labor units at completion of the activity. Calculated as <b>actual labor units</b> plus <b>estimated to completion labor units</b>.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "plannedValueLaborUnits":{
            "type":"integer",
            "description":"The portion of baseline labor units that are scheduled to be complete as of the project data date.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "floatPathOrder":{
            "type":"integer",
            "description":"The position of the activity on its critical path.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "plannedStart":{
            "type":"string",
            "description":"The date the activity is scheduled to begin.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedFinish":{
            "type":"string",
            "description":"The date the activity is scheduled to end if the activity has not started. It is calculated by the scheduler and will not change after the activity has started.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualStart":{
            "type":"string",
            "description":"The date work on the activity began.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualFinish":{
            "type":"string",
            "description":"The date when the activity was completed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineStartDate":{
            "type":"string",
            "description":"Current start date of the activity in the project baseline.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineFinishDate":{
            "type":"string",
            "description":"Current finish date for the activity in the project baseline.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "rollupType":{
            "type":"string",
            "description":"The type of rollup.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVITY_TO_WORK_PACKAGE",
                "ACTIVITY_TO_PROJECT"
            ]
        },
        "referenceObjectId":{
            "type":"integer",
            "description":"The unique identifier of an activity reference object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "lateStart":{
            "type":"string",
            "description":"The latest possible date the remaining work for the activity can begin without delaying the project finish date.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lateFinish":{
            "type":"string",
            "description":"The latest possible date the activity can finish without delaying the project finish date.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "earlyStart":{
            "type":"string",
            "description":"The earliest possible date the remaining work for the activity can begin. ",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "earlyFinish":{
            "type":"string",
            "description":"The earliest possible date the remaining work for the activity can begin. ",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingFinish":{
            "type":"string",
            "description":"The date the remaining work for the activity is scheduled to end.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingStart":{
            "type":"string",
            "description":"The date the remaining work for the activity is scheduled to begin.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "expectedFinish":{
            "type":"string",
            "description":"The date work on the activity is expected to end.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingLateStart":{
            "type":"string",
            "description":"The latest possible date the remaining work for the activity must begin without delaying the project finish date.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingLateFinish":{
            "type":"string",
            "description":"The latest possible date the activity must finish without delaying the project finish date.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "floatPath":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "baselineDuration":{
            "type":"number",
            "description":"Total number of hours allotted to the activity in the project baseline.",
            "format":"double",
            "exampleSetFlag":false
        },
        "baselinePlannedLaborUnits":{
            "type":"integer",
            "description":"The planned number of units for all labor resources assigned to the activity in the project baseline.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "baselinePlannedNonLaborUnits":{
            "type":"integer",
            "description":"The planned units for all nonlabor resources assigned to the activities in the project baseline.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "activityAggregateId":{
            "type":"integer",
            "description":"The unique identifier of a rollup.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested activity aggregate does not exist, or you do not have access to it.

Back to Top