Returns all CBS codes for the specified workspace ID or project ID.
get
/primeapi/restapi/v16.2/cbs/workspace/{id}
Request
Path Parameters
- id
-
Type:
integer(int64)Required:trueThe ID of the workspace/project for which you want to load all CBS codes.
Response
Supported Media Types
- application/json
200 Response
successful operation
Body
Root Schema : ApiEntityCBSTemplateCode
Type:
object- cbsCode
-
Type:
stringAllowed Values:[ "Length[1-60]" ]The code value of the CBS code. The code may have one or more segments according the ot the segment definition. - cbsItemId
-
Type:
integer(int64)Required:trueThe unique identifier of the original CBS. - cbsTemplateId
-
Type:
integer(int64)Required:trueThe unique identifier for the CBS template. - copiedFromTemplateItem
-
Type:
integer(int64)Required:trueThe unique identifier for the CBS template that the CBS was copied from. - costType
-
Type:
stringRequired:trueAllowed 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
-
Type:
stringRequired:trueAllowed Values:[ "Length[0-255]" ]The name of the CBS Code. - isActive
-
Type:
booleanRequired:trueDefault Value:falseThe active field indicates whether the CBS code is active for use. - isCodeCopied
-
Type:
booleanRequired:trueDefault Value:falseIndicates a CBS that is copied from a workspace or project. - isTotalRow
-
Type:
booleanRequired:trueDefault Value:falseThe total cost of the project. - parent
-
Type:
integer(int64)Required:trueThe unique identifier of the parent CBS. - pushDownStatus
-
Type:
booleanRequired:trueDefault Value:false - sequenceNumber
-
Type:
integer(int64)Required:trueUsed to display the CBS codes in the increasing order of sequence numbers.