CBS REST Endpoints
CBS
Use the CBS service enables you to create, view, update, or delete cost breakdown structure codes for a workspace or project. A CBS is used to track, manage, and report costs related to a project. CBS codes enable you to define and track custom cost data within project or workspace CBS.
- Batch Integrate CBSs with an External Data Source
- Method: postPath:
/api/restapi/cbs/project/syncBatch
- Create a Project CBS
- Method: postPath:
/api/restapi/cbs/createprojectCBS
- Create a Project Costing Source
- Method: postPath:
/api/restapi/cbs/project/{projectId}/projectCostingSource
- Create a Workspace CBS
- Method: postPath:
/api/restapi/cbs/createworkspaceCBS
- Delete a Project CBS Code by Project CBS ID
- Method: deletePath:
/api/restapi/cbs/project/{cbsSheetCodeId}
- Delete a Workspace CBS Code by Workspace CBS ID
- Method: deletePath:
/api/restapi/cbs/workspace/{cbsTemplateCodeId}
- Import a Workspace CBS to a Program
- Method: putPath:
/api/restapi/cbs/import/workspaceCbs/{cbsTemplateCodeId}/program/{programId}
- Integrate a CBS with an External Data Source
- Method: postPath:
/api/restapi/cbs/project/sync
- Push Down all Workspace CBS Code to Project
- Method: putPath:
/api/restapi/cbs/import/workspace/{workspaceCode}/project/{projectCode}
- Recalculate Program Cost Sheet
- Method: postPath:
/api/restapi/cbs/recalculate/program/{programId}
- Recalculate Project Cost Sheet
- Method: postPath:
/api/restapi/cbs/recalculate/project/{projectId}
- Recalculate Workspace Cost Sheet
- Method: postPath:
/api/restapi/cbs/recalculate/workspace/{workspaceId}
- Reset all Program CBS Template Codes
- Method: deletePath:
/api/restapi/cbs/resetProgramCBS/program/{programId}
- Reset all Project Cost Sheet Code
- Method: deletePath:
/api/restapi/cbs/resetCostSheet/workspace/{workspaceCode}/project/{projectCode}
- Reset Workspace CBS Template
- Method: deletePath:
/api/restapi/cbs/resetCBSTemplate/workspace/{workspaceCode}
- Update a Project CBS Code by CBS
- Method: putPath:
/api/restapi/cbs/project
- Update a Project Costing Source
- Method: putPath:
/api/restapi/cbs/project/{projectId}/projectCostingSource
- Update a Workspace CBS Code
- Method: putPath:
/api/restapi/cbs/workspace
- View a CBS Sheet Code by Project and CBS Code
- Method: getPath:
/api/restapi/cbs/project/{projectId}/code/{cbsCode}
- View a CBS Sheet Total Cost Row by Project
- Method: getPath:
/api/restapi/cbs/project/{projectId}/totalCost
- View a Project CBS
- Method: getPath:
/api/restapi/cbs/projectCbs/{cbsSheetCodeId}
- View a Project Costing Source
- Method: getPath:
/api/restapi/cbs/project/{projectId}/projectCostingSource
- View a Workspace CBS
- Method: getPath:
/api/restapi/cbs/workspaceCbs/{cbsTemplateCodeId}
- View a workspace CBS by code
- Method: getPath:
/api/restapi/cbs/workspace/byItemCode
- View a Workspace Total Item by ID and Template Type
- Method: getPath:
/api/restapi/cbs/aggregate/reference/{referenceObjectId}
- View all Project CBS Assigned to a Project
- Method: getPath:
/api/restapi/cbs/project/{projectId}
- View all project CBSs by parent code
- Method: getPath:
/api/restapi/cbs/project/byParent
- View all Workspace CBS Codes Assigned to a Workspace
- Method: getPath:
/api/restapi/cbs/workspace/{workspaceId}
- View all workspace CBSs by parent code
- Method: getPath:
/api/restapi/cbs/workspace/byParent
- View Integrated CBSs
- Method: getPath:
/api/restapi/cbs/project/externallySourced