View all Project CBS Assigned to a Project

get

/api/restapi/cbs/project/{projectId}

This endpoint returns CBS codes that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
A CBS is used to track, manage, and report costs related to a project.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : List<ApiEntityCBSSheetCode>
Type: array
Title: List<ApiEntityCBSSheetCode>
Show Source
Nested Schema : ApiEntityCBSSheetCode
Type: object
Title: ApiEntityCBSSheetCode
Show Source
Nested Schema : costSheetRow
A CBS sheet row object.
Match All
Show Source
Nested Schema : costSheetRowCost
The cost of a CBS sheet row.
Match All
Show Source
Nested Schema : parentCBSCodes
Type: array
List of parent cbs codes in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
Show Source
Nested Schema : ApiEntityCBSSheetRow
Type: object
Title: ApiEntityCBSSheetRow
Show Source
  • The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).
    This is the cumulative value for all objects in the project with the same CBS code.
  • The sum of all approved change hours in the change and transfer records for the scope assignment.
    This is the cumulative value for all objects in the project with the same CBS code.
  • The total hours expected for the scope assignment.
    Calculated as Revised Hours plus Adjusted Hours.
    This is the cumulative value for all objects in the project with the same CBS code.
  • 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.
    This is the cumulative value for all objects in the project with the same CBS code.
  • The Revised Hours at the time the baseline was set.
    This is the cumulative value for all objects in the project with the same CBS code.
  • The CBS code assigned to the line item.
  • configuredFields
    An object containing configured fields in the form of key-value pairs.
  • Calculated as ETC Hours plus Actual Hours to Date.
    This is the cumulative value for all objects in the project with the same CBS code.
  • Calculated as Performance Percent Complete multiplied by BAC Hours.
    This is the cumulative value for all objects in the project with the same CBS code.
  • 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.
    This is the cumulative value for all objects in the project with the same CBS code.
  • The estimated number of hours needed to complete the work.
    Calculated as BAC Hours minus Earned Hours.
    This is the cumulative value for all objects in the project with the same CBS code.
  • Hours spent on the scope assignment.
    Calculated as Installed Quantity multiplied by Revised Productivity Rate.
    This is the cumulative value for all objects in the project with the same CBS code.
  • Calculated as the sum of all pending hour changes in the change records for the scope assignment.
    This is the cumulative value for all objects in the project with the same CBS code.
  • 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.
    This is the cumulative value for all objects in the project with the same CBS code.
  • The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).
  • Calculated as Performance Percent Complete multiplied by BAC Hours.
  • Calculated as the total of Project Earned Hours divided by Project Actual Hours.
  • The number of hours left for the scope assignment.
    Calculated as Remaining Quantity multiplied by Revised Productivity Rate.
    This is the cumulative value for all objects in the project with the same CBS code.
  • Original Hours before the baseline is set. After the baseline is set, Revised Hours is equal to Original Hours plus Approved Change Hours.
    This is the cumulative value for all objects in the project with the same CBS code.
  • Date when the record was last updated.
Nested Schema : configuredFields
Type: array
An object containing configured fields in the form of key-value pairs.
Show Source
Nested Schema : ApiEntityCBSSheetRowConfiguredFieldValue
Type: object
Title: ApiEntityCBSSheetRowConfiguredFieldValue
Show Source
Nested Schema : ApiEntityCBSSheetRowCost
Type: object
Title: ApiEntityCBSSheetRowCost
Read Only: true
Show Source

204 Response

Successful operation with no content.

404 Response

The requested object does not exist, or you do not have access to it.
Back to Top