View all workspace CBSs by parent code
get
/api/restapi/cbs/workspace/byParent
Send a request to this endpoint to view all workspace CBSs under parent with codes matching the code fields in query parameters.
Request
Query Parameters
-
workspaceCode(required): string
Workspace code under which all the workspace CBSs have to be found.
This is a required field.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityCBSTemplateCode>
Type:
arrayTitle:
Show Source
List<ApiEntityCBSTemplateCode>-
Array of:
object ApiEntityCBSTemplateCode
Title:
ApiEntityCBSTemplateCode
Nested Schema : ApiEntityCBSTemplateCode
Type:
objectTitle:
Show Source
ApiEntityCBSTemplateCode-
cbsCode: string
Minimum Length:
1Maximum Length:60The code value of the CBS code. The code may have one or more segments according the ot the segment definition. -
cbsTemplateCodeId: integer
(int64)
The unique identifier of the original CBS. This value should not be provided in create operation request data, however, it is required for update requests.
-
cbsTemplateId: integer
(int64)
The unique identifier for the CBS template.
-
copiedFromItemId: integer
(int64)
The unique identifier for the CBS template that the CBS was copied from.
-
costType: string
Allowed Values:
[ "CAPITAL", "EXPENSE", "NONE" ]The category of the cost breakdown structure code.
Expense: Represents an expense.
Capital: Represents capital.
None: Type is not divided into expense or capital. None is selected by default if no other choice is made. -
description: string
Minimum Length:
0Maximum Length:255The name of the CBS Code. -
isActive: boolean
The active field indicates whether the CBS code is active for use.
-
isCodeCopied: boolean
Indicates a CBS that is copied from a workspace or project.
-
isTotalRow: boolean
The total cost of the project.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
parentCBSCodes: array
parentCBSCodes
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.
-
parentId: integer
(int64)
The unique identifier of the parent CBS.
-
pushDownStatus: boolean
The push down status of a cbs template code. May be manual or automatic.
-
sequenceNumber: integer
(int32)
Used to display the CBS codes in the increasing order of sequence numbers.
-
templateRow:
templateRow
A CBS template row object.
-
templateRowCost:
templateRowCost
A CBS template row cost object.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0Maximum Length:60The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Nested Schema : parentCBSCodes
Type:
arrayList 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 : templateRow
A CBS template row object.
Match All
Show Source
-
object
ApiEntityCBSTemplateRow
Title:
ApiEntityCBSTemplateRow
Nested Schema : templateRowCost
A CBS template row cost object.
Match All
Show Source
-
object
ApiEntityCBSTemplateRowCost
Title:
ApiEntityCBSTemplateRowCostRead Only:true
Nested Schema : ApiEntityCBSTemplateRow
Type:
objectTitle:
Show Source
ApiEntityCBSTemplateRow-
actualHoursToDate: number
(double)
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 workspace with the same CBS code. -
approvedChangedHours: number
(double)
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 workspace with the same CBS code. -
atCompletionHours: number
(double)
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 workspace with the same CBS code. -
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.
This is the cumulative value for all objects in the workspace with the same CBS code. -
baselineHours: number
(double)
The Revised Hours at the time the baseline was set.
This is the cumulative value for all objects in the workspace with the same CBS code. -
cbsTemplateCodeId: integer
(int64)
The CBS code assigned to the line item.
-
configuredFields: array
configuredFields
An object containing configured fields in the form of key-value pairs.
-
eacHours: number
(double)
Calculated as ETC Hours plus Actual Hours to Date.
This is the cumulative value for all objects in the workspace with the same CBS code. -
earnedHours: number
(double)
Calculated as Performance Percent Complete multiplied by BAC Hours.
This is the cumulative value for all objects in the workspace with the same CBS code. -
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.
This is the cumulative value for all objects in the workspace with the same CBS code. -
etcHours: number
(double)
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 workspace with the same CBS code. -
installedHours: number
(double)
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 workspace with the same CBS code. -
link: string
(url)
The 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.
This is the cumulative value for all objects in the workspace with the same CBS code. -
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.
This is the cumulative value for all objects in the workspace with the same CBS code. -
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.
This is the cumulative value for all objects in the workspace with the same CBS code. -
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.
This is the cumulative value for all objects in the workspace with the same CBS code. -
templateItemId: integer
(int64)
The CBS code assigned to the line item.
-
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : configuredFields
Type:
arrayAn object containing configured fields in the form of key-value pairs.
Show Source
-
Array of:
object ApiEntityCBSTemplateRowConfiguredFieldValue
Title:
ApiEntityCBSTemplateRowConfiguredFieldValue
Nested Schema : ApiEntityCBSTemplateRowConfiguredFieldValue
Type:
objectTitle:
Show Source
ApiEntityCBSTemplateRowConfiguredFieldValue-
action: string
Allowed Values:
[ "DELETE" ]Provide value for this field during object update to delete the assigned configured field value. -
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1Maximum Length:100The user-specified UDF column label. -
columnName: string
Minimum Length:
1Maximum Length:100The user-specified UDF column name. -
costSheetRowId: integer
(int64)
The system-generated identifier for an CBS Code assigned to the line item.
-
costValue: number
This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
-
costValueWorkspace1: number
(double)
This holds values for Cost type configured fields in the workspace1 currency conversion.
-
costValueWorkspace2: number
(double)
This holds values for Cost type configured fields in the workspace2 currency conversion.
-
costValueWorkspace3: number
(double)
This holds values for Cost type configured fields in the workspace3 currency conversion.
-
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: string
Maximum Length:
4000Provides the error message for why the formula calculation resulted in an error. -
hasException: boolean
Determines if formula calculation hit an error calculating a value for this field.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
textValue: string
Maximum Length:
4000This holds values for Boolean, List and Text type configured fields. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCostSheetConfiguredFieldValueId: integer
(int64)
The unique identifier for the Workspace Cost Sheet Configured Field.
Nested Schema : ApiEntityCBSTemplateRowCost
Type:
objectTitle:
ApiEntityCBSTemplateRowCostRead Only:
Show Source
true-
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 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.
-
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. Calculated based on the workspace currency.
-
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. Calculated based on the workspace currency.
-
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. Calculated based on the workspace currency.
-
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.
-
cbsTemplateCodeId: integer
(int64)
Template item ID.
-
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)
Workspace current budget.
-
currentBudgetWorkspace2: number
(double)
Workspace current budget.
-
currentBudgetWorkspace3: number
(double)
Workspace current budget.
-
eacCost: number
(double)
Calculated as ETC Cost plus Actual Cost to Date.
-
eacCostWorkspace1: number
(double)
Calculated as ETC Cost plus Actual Cost to Date, calculated based on the workspace currency.
-
eacCostWorkspace2: number
(double)
Calculated as ETC Cost plus Actual Cost to Date, calculated based on the workspace currency.
-
eacCostWorkspace3: number
(double)
Calculated as ETC Cost plus Actual Cost to Date, calculated 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, calculated based on the workspace currency.
-
earnedCostWorkspace2: number
(double)
Calculated as Performance Percent Complete multiplied by BAC Cost, calculated based on the workspace currency.
-
earnedCostWorkspace3: number
(double)
Calculated as Performance Percent Complete multiplied by BAC Cost, calculated 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, calculated based on the workspace currency.
-
projectActualCostWorkspace2: number
(double)
Total costs accrued on a project within a given time period, calculated based on the workspace currency.
-
projectActualCostWorkspace3: number
(double)
Total costs accrued on a project within a given time period, calculated 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, calculated based on the workspace currency.
-
revisedCostWorkspace2: number
(double)
The Original Cost before the baseline is set, calculated based on the workspace currency.
-
revisedCostWorkspace3: number
(double)
The Original Cost before the baseline is set, calculated based on the workspace currency.
-
updateDate: string
(date-time)
Read Only:
trueDate when the record was last updated.
204 Response
Successful operation with no content.
404 Response
The requested object does not exist, or you do not have access to it.