View a Workspace Total Item by ID and Template Type
get
/api/restapi/cbs/aggregate/reference/{referenceObjectId}
This endpoint returns workspace total items 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 template with a type that matches one or more values of the {templateType} query parameter.
Request
Path Parameters
-
referenceObjectId(required): integer(int64)
The unique identifier of the project or workspace that owns the cost values.
Query Parameters
-
templateType(required): string
The Rollup type for workspace total item.
This is a required field.Allowed Values:[ "WORKSPACE", "PROJECT" ]
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityWorkspaceTotalItem
Type:
objectTitle:
Show Source
ApiEntityWorkspaceTotalItem-
aggregateId: integer
(int64)
The unique identifier of the rollup record.
-
link: string
(url)
Read Only:
trueThe self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
parentWorkspace: integer
(int64)
The unique identifier of the workspace hierarchically above another workspace.
-
referenceObjectId: integer
(int64)
The unique identifier of the project or workspace that owns the cost values.
-
rollupType: string
Allowed Values:
[ "WORKSPACE", "PROJECT", "PROGRAM" ]The rollupType specifies whether the rollup values belong to a project or a workspace. -
updateDate: string
(date-time)
Read Only:
trueDate when the record was last updated. -
workspaceTotalRow:
workspaceTotalRow
Defines the spread rows for a workspace total item.
-
workspaceTotalRowCost:
workspaceTotalRowCost
Defines the cost associated with the spread rows of the workspace total item.
Nested Schema : workspaceTotalRow
Defines the spread rows for a workspace total item.
Match All
Defines the spread rows for a workspace total item.
Show Source
-
object
ApiEntityWorkspaceTotalRow
Title:
ApiEntityWorkspaceTotalRow
Nested Schema : workspaceTotalRowCost
Defines the cost associated with the spread rows of the workspace total item.
Match All
Defines the cost associated with the spread rows of the workspace total item.
Show Source
-
object
ApiEntityWorkspaceTotalRowCost
Title:
ApiEntityWorkspaceTotalRowCost
Nested Schema : ApiEntityWorkspaceTotalRow
Type:
objectTitle:
Show Source
ApiEntityWorkspaceTotalRow-
actualHoursToDate: number
(double)
The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).
-
aggregateId: integer
(int64)
The unique identifier of the rollup record.
-
approvedChangedHours: number
(double)
The sum of all approved change hours in the change and transfer records for the scope assignment.
-
atCompletionHours: number
(double)
The total hours expected for the scope assignment.
Calculated as Revised Hours plus Adjusted Hours. -
bacHours: number
(double)
The Revised Hours or At Completion Hours at the time the current baseline was set, depending on the selection for the Budget At Completion Method. The Revised Hours of the current project if no baseline is set.
-
baselineHours: number
(double)
The Revised Hours at the time the baseline was set.
-
eacHours: number
(double)
Calculated as ETC Hours plus Actual Hours to Date.
-
earnedHours: number
(double)
Calculated as Performance Percent Complete multiplied by BAC Hours.
-
etcAdjustedHours: number
(double)
The amount of scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
-
etcHours: number
(double)
The estimated number of hours needed to complete the work.
Calculated as BAC Hours minus Earned Hours. -
installedHours: number
(double)
Hours spent on the scope assignment.
Calculated as Installed Quantity multiplied by Revised Productivity Rate. -
link: string
(url)
Read Only:
trueThe self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
pendingChangedHours: number
(double)
Calculated as the sum of all pending hour changes in the change records for the scope assignment.
-
plannedHours: number
(double)
The original expected hours needed to complete all the work required to install the material quantity on the scope assignment.
Calculated as Original Quantity multiplied by Original Productivity Rate.
Before the baseline is set, this field can be entered manually. A manual entry recalculates the Original Productivity Rate to equal Original Hours divided by Original Quantity. -
projectActualHours: number
(double)
The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).
-
projectEarnedHours: number
(double)
Calculated as Performance Percent Complete multiplied by BAC Hours.
-
projectHPI: number
(double)
Calculated as the total of Project Earned Hours divided by Project Actual Hours.
-
remainingHours: number
(double)
The number of hours left for the scope assignment.
Calculated as Remaining Quantity multiplied by Revised Productivity Rate. -
revisedHours: number
(double)
Original Hours before the baseline is set. After the baseline is set, Revised Hours is equal to Original Hours plus Approved Change Hours.
-
updateDate: string
(date-time)
Read Only:
trueDate when the record was last updated.
Nested Schema : ApiEntityWorkspaceTotalRowCost
Type:
objectTitle:
Show Source
ApiEntityWorkspaceTotalRowCost-
actualCostToDate: number
(double)
The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done).
-
actualCostToDateWorkspace1: number
(double)
The actual costs incurred on the scope assignment, calculated based on the workspace currency.
-
actualCostToDateWorkspace2: number
(double)
The actual costs incurred on the scope assignment, calculated based on the workspace currency.
-
actualCostToDateWorkspace3: number
(double)
The actual costs incurred on the scope assignment, calculated based on the workspace currency.
-
adjustedCost: number
(double)
The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
-
adjustedCostWorkspace1: number
(double)
The amount of scope assignment work that is not yet accounted for, calculated based on the workspace currency.
-
adjustedCostWorkspace2: number
(double)
The amount of scope assignment work that is not yet accounted for, calculated based on the workspace currency.
-
adjustedCostWorkspace3: number
(double)
The amount of scope assignment work that is not yet accounted for, calculated based on the workspace currency.
-
approvedChangedCost: number
(double)
The sum of all approved cost changes in the change records for the scope assignment.
-
approvedChangedCostWorkspace1: number
(double)
The sum of all approved cost changes in the change records for the scope assignment, calculated based on the workspace currency.
-
approvedChangedCostWorkspace2: number
(double)
The sum of all approved cost changes in the change records for the scope assignment, calculated based on the workspace currency.
-
approvedChangedCostWorkspace3: number
(double)
The sum of all approved cost changes in the change records for the scope assignment, calculated based on the workspace currency.
-
atCompletionCost: number
(double)
The total cost at the completion of the scope assignment.
Calculated as Revised Cost plus Adjusted Cost. -
atCompletionCostWorkspace1: number
(double)
The total cost at the completion of the scope assignment, calculated based on the workspace currency.
-
atCompletionCostWorkspace2: number
(double)
The total cost at the completion of the scope assignment, calculated based on the workspace currency.
-
atCompletionCostWorkspace3: number
(double)
The total cost at the completion of the scope assignment, calculated based on the workspace currency.
-
bacCost: number
(double)
The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set.
-
bacCostWorkspace1: number
(double)
The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method based on the workspace currency.The Revised Cost of the current project if no baseline is set.
-
bacCostWorkspace2: number
(double)
The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method based on the workspace currency.The Revised Cost of the current project if no baseline is set.
-
bacCostWorkspace3: number
(double)
The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method based on the workspace currency.The Revised Cost of the current project if no baseline is set.
-
baselineCost: number
(double)
The Revised Cost at the time the current baseline was set.
-
baselineCostWorkspace1: number
(double)
The Revised Cost at the time the current baseline was set, calculated based on the workspace currency.
-
baselineCostWorkspace2: number
(double)
The Revised Cost at the time the current baseline was set, calculated based on the workspace currency.
-
baselineCostWorkspace3: number
(double)
The Revised Cost at the time the current baseline was set, calculated based on the workspace currency.
-
currentBudget: number
(double)
The total approved current manual budget of a project.Calculated as the sum of Approved Original Manual Budget plus Approved Manual Budget Changes plus Approved Manual Budget Transfers.
-
currentBudgetWorkspace1: number
(double)
The total approved manual budget of a set of projects, calculated based on the workspace currency.
-
currentBudgetWorkspace2: number
(double)
The total approved manual budget of a set of projects, calculated based on the workspace currency.
-
currentBudgetWorkspace3: number
(double)
The total approved manual budget of a set of projects, calculated based on the workspace currency.
-
eacCost: number
(double)
Calculated as ETC Cost plus Actual Cost to Date.
-
eacCostWorkspace1: number
(double)
Calculated as ETC Cost plus Actual Cost to Date based on the workspace currency.
-
eacCostWorkspace2: number
(double)
Calculated as ETC Cost plus Actual Cost to Date based on the workspace currency.
-
eacCostWorkspace3: number
(double)
Calculated as ETC Cost plus Actual Cost to Date based on the workspace currency.
-
earnedCost: number
(double)
Calculated as Performance Percent Complete multiplied by BAC Cost.
-
earnedCostWorkspace1: number
(double)
Calculated as Performance Percent Complete multiplied by BAC Cost based on the workspace currency.
-
earnedCostWorkspace2: number
(double)
Calculated as Performance Percent Complete multiplied by BAC Cost based on the workspace currency.
-
earnedCostWorkspace3: number
(double)
Calculated as Performance Percent Complete multiplied by BAC Cost based on the workspace currency.
-
etcCost: number
(double)
The estimate of the cost needed to complete the work.
Calculated as BAC Cost minus Earned Cost. -
etcCostWorkspace1: number
(double)
The estimate of the cost needed to complete the work. Calculated based on the workspace currency.
-
etcCostWorkspace2: number
(double)
The estimate of the cost needed to complete the work. Calculated based on the workspace currency.
-
etcCostWorkspace3: number
(double)
The estimate of the cost needed to complete the work. Calculated based on the workspace currency.
-
installedCost: number
(double)
The total cost incurred on the scope assignment as of the current date.
If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours.
If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. -
installedCostWorkspace1: number
(double)
The total cost incurred on the scope assignment as of the current date, calculated based on the workspace currency.
-
installedCostWorkspace2: number
(double)
The total cost incurred on the scope assignment as of the current date, calculated based on the workspace currency.
-
installedCostWorkspace3: number
(double)
The total cost incurred on the scope assignment as of the current date, calculated based on the workspace currency.
-
link: string
(url)
Read Only:
trueThe self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
pendingChangedCost: number
(double)
Calculated as the sum of all pending cost changes in the change records for the scope assignment.
-
pendingChangedCostWorkspace1: number
(double)
Calculated as the sum of all pending cost changes in the change records for the scope assignment, calculated based on the workspace currency.
-
pendingChangedCostWorkspace2: number
(double)
Calculated as the sum of all pending cost changes in the change records for the scope assignment, calculated based on the workspace currency.
-
pendingChangedCostWorkspace3: number
(double)
Calculated as the sum of all pending cost changes in the change records for the scope assignment, calculated based on the workspace currency.
-
plannedCost: number
(double)
The original cost of the scope assignment.
If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours.
If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity. -
plannedCostWorkspace1: number
(double)
The original cost of the scope assignment, calculated based on the workspace currency.
-
plannedCostWorkspace2: number
(double)
The original cost of the scope assignment, calculated based on the workspace currency.
-
plannedCostWorkspace3: number
(double)
The original cost of the scope assignment, calculated based on the workspace currency.
-
projectActualCost: number
(double)
Total costs accrued on a project within a given time period.
The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. -
projectActualCostWorkspace1: number
(double)
Total costs accrued on a project within a given time period based on the workspace currency.
-
projectActualCostWorkspace2: number
(double)
Total costs accrued on a project within a given time period based on the workspace currency.
-
projectActualCostWorkspace3: number
(double)
Total costs accrued on a project within a given time period based on the workspace currency.
-
projectCPI: number
The measure of a project's cost efficiency.
A value of less than 1 indicates the project is over budget, while a value greater than 1 indicates the project is under budget. -
projectEarnedCost: number
(double)
The value of work performed on a project in reference to the approved budget for the project.
The cost value used for the Earned Value Management of a project.
Earned Value Management allows project managers to quantify project progress and objectively measure a project's success. -
remainingCost: number
(double)
The amount left to be spent.
If Rate By set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
If Rate By set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. -
remainingCostWorkspace1: number
(double)
The amount left to be spent, calculated based on the workspace currency.
-
remainingCostWorkspace2: number
(double)
The amount left to be spent, calculated based on the workspace currency.
-
remainingCostWorkspace3: number
(double)
The amount left to be spent, calculated based on the workspace currency.
-
revisedCost: number
(double)
The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost.
-
revisedCostWorkspace1: number
(double)
The Original Cost before the baseline is set based on the workspace currency.
-
revisedCostWorkspace2: number
(double)
The Original Cost before the baseline is set based on the workspace currency.
-
revisedCostWorkspace3: number
(double)
The Original Cost before the baseline is set based on the workspace currency.
-
updateDate: string
(date-time)
Read Only:
trueDate when the record was last updated. -
workspaceTotalItemId: integer
(int64)
The system-generated identifier of a workspace total item.
404 Response
The requested object does not exist, or you do not have access to it.