View a Project Aggregate by Reference ID and Rollup Type
get
/api/restapi/projectsAggregate/reference/{referenceObjectId}/rollupType/{rollupType}
This endpoint returns project aggregates that meet the following requirements:
- The object has a reference to another object with an ID value that matches the value of the {referenceObjectId} path parameter.
- The object has a rollup with an ID value that matches the value of the {rollupId} path parameter.
Request
Path Parameters
-
referenceObjectId(required): integer(int64)
Reference ID and rollup type for the projects aggregates to be found.
-
rollupType(required): string
The rollup type of a project aggregate.Allowed Values:
[ "PROJECT_2_CAPITAL_PLAN", "PROJECT_PORTFOLIO" ]
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityProjectsAggregate>
Type:
arrayTitle:
Show Source
List<ApiEntityProjectsAggregate>-
Array of:
object ApiEntityProjectsAggregate
Title:
ApiEntityProjectsAggregate
Nested Schema : ApiEntityProjectsAggregate
Type:
objectTitle:
Show Source
ApiEntityProjectsAggregate-
actualDuration: number
(double)
The total working time between the project actual start and actual finish.
-
actualFinishDate: string
(date-time)
The date on which a project is considered complete.
-
actualStartDate: string
(date-time)
Indicates the date work on the project began.
-
finishDate: string
(date-time)
The date on which work on the project ends.
-
finishDateVariance: number
(double)
The duration between the project's finish date and default snapshot.
-
forecastFinishDate: string
(date-time)
The planned finish date of a project's remaining forecast cost.
-
forecastStartDate: string
(date-time)
The planned start date of a project's remaining forecast cost.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
planEndDate: string
(date-time)
The finish date for the time phased planned budget of the project. Planned budget cost spread will adjust when this date is changed.
-
plannedDuration: number
(double)
The duration between project planned start and project planned finish.
-
planStartDate: string
(date-time)
The start date for the time phased planned budget of the project. Planned budget cost spread will adjust when this date is changed. The project planned start also represents the earliest date that activities can occur within a project schedule.
-
projectAggregateFinancial:
projectAggregateFinancial
A project's aggregated cost information.
-
projectsAggregateId: integer
(int64)
The unique identifier of a rollup. This value should not be provided in create operation request data, however, it is required for update requests.
-
recordCount: integer
(int32)
The number of comments on a project.
-
referenceObjectId: integer
(int64)
The unique identifier of a project cost reference.
-
remainingDuration: number
(double)
The duration between the project start and project finish.
-
rollupType: string
Allowed Values:
[ "PROJECT_2_CAPITAL_PLAN", "PROJECT_PORTFOLIO" ]The type of rollup. -
spendEffectiveDate: string
(date-time)
The month in which an actuals value was last added to the project.
-
startDate: string
(date-time)
The date on which work on the project begins.
-
startDateVariance: number
(double)
The duration between the project's start date and default snapshot.
-
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : projectAggregateFinancial
A project's aggregated cost information.
Match All
Show Source
-
object
ApiEntityProjectsAggregateFinancial
Title:
ApiEntityProjectsAggregateFinancial
Nested Schema : ApiEntityProjectsAggregateFinancial
Type:
objectTitle:
Show Source
ApiEntityProjectsAggregateFinancial-
actualCost: number
(double)
Total costs accrued on a project within a given time period.
-
atCompletionCost: number
(double)
The at completion total cost from a cost-loaded P6 schedule.
-
costPerfIndex: number
(double)
The measure of a project's cost efficiency.
-
costVariance: number
(double)
The measure of cost performance on a project.
-
currApprSpendVar: number
(double)
The variance between a project's approved budget and actual cost.
-
currentApprovedBudget: number
(double)
The budget currently approved for the project. Current approved budget values are derived from the proposed budget.
-
currentApprovedBudgetDistributed: number
(double)
The budget currently approved for the project. Current approved budget values are derived from the proposed budget set by the budget planner. A proposed budget becomes the approved budget after the budget scenario has undergone the approval process.
-
currentApprovedBudgetUndistributed: number
(double)
The budget currently approved for the project. Current approved budget values are derived from the proposed budget. A proposed budget becomes an approved budget after the budget scenario has undergone the approval process.
-
earnedValueCost: number
(double)
The value of work performed on a project in reference to the approved budget for the project.
-
estAtCompleteCost: number
(double)
The expected total cost of the project when the defined scope of work will be completed.
-
estToCompleteCost: number
(double)
The estimated cost needed to complete the project.
-
forecastCost: number
(double)
The total estimation of a project's remaining costs.
-
forecastCostDistributed: number
(double)
The total estimation of a project's remaining costs.
-
forecastCostUndistributed: number
(double)
The total estimation of a project's remaining costs.
-
forecastCurrApprVar: number
(double)
The total and time phased variance between the project's forecast and approved budget.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
netPresentValue: number
(double)
The difference between the present value (PV) of the future cash flows from current investments and project costs.
-
paybackPeriod: number
(double)
The estimate of the length of time that will transpire before net profits recover the initial and periodic costs of an investment to carry out the selected project.
-
plannedBudget: number
(double)
The planned total cost of a project.
-
plannedBudgetDistributed: number
(double)
The planned total cost of a project.
-
plannedBudgetUndistributed: number
(double)
The planned total cost of a project.
-
plannedValueCost: number
(double)
The amount of approved capital spent on a scheduled portion of work on a project.
-
profitabilityIndex: number
(double)
The index based on the value of a project's present values divided by initial project investments.
-
projectsAggregateId: integer
(int64)
The unique identifier of a rollup.
-
proposedBudgetBase: number
(double)
The proposed budget allocated to a project.
-
proposedBudgetBaseDistributed: number
(double)
The proposed budget allocated to a project.
-
proposedBudgetBaseUndistributed: number
(double)
The proposed budget allocated to a project.
-
proposedForecastVar: number
(double)
The total and time phased variance between the project's proposed budget and forecast.
-
proposedPlannedVar: number
(double)
The total and time phased variance between the project's proposed budget and planned budget.
-
referenceObjectId: integer
(int64)
The unique identifier of a project cost reference.
-
remainingCost: number
(double)
The remaining total cost for the project, including labor resources, nonlabor resources, and project expenses.
-
rollupType: string
Allowed Values:
[ "PROJECT_2_CAPITAL_PLAN", "PROJECT_PORTFOLIO" ]The type of rollup. -
schedPerfIndex: number
(double)
The measure of work accomplished as a percentage of the work scheduled on a project.
-
scheduleVariance: number
(double)
The measure of schedule performance on a project.
-
spendCost: number
(double)
The time phased actual spends incurred on a project throughout its lifecycle, such as the cost of invoices, payments, or accruals.
-
spendForecastVar: number
(double)
The variance between a project's actual cost and forecast.
-
spendPlannedVar: number
(double)
The variance between a project's actual cost and planned budget.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
yearEndForecastCost: number
(double)
Total forecast at the end of year actuals till date, with respect to the current year.
-
ytdSpendCost: number
(double)
A measurement of capital spent on a project starting from the beginning of the year up to the present date.
204 Response
Successful operation with no content.
404 Response
The requested projects aggregate does not exist, or you do have access to it.