Jump to

• Request
• Response

Update a Workspace CBS Code

put

/api/restapi/cbs/workspace

Send a request to this endpoint to update a workpsace CBS code. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.
Update Key : 'cbsTemplateCodeId'

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityCBSTemplateCodeInput

Type: object

Title: ApiEntityCBSTemplateCodeInput

This entity represents a CBSTemplateCode object, a unique CBSTemplateCode object can be identified by the following combinations of the fields.

• cbsTemplateCodeId
• cbsCode,workspaceId
• cbsCode,workspaceCode

Show Source

• cbsCode: string
  Minimum Length: 1

  Maximum Length: 60

  The 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: 0

  Maximum Length: 255

  The name of the CBS Code.
• isActive: boolean
  The active field indicates whether the CBS code is active for use.
• 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.
• templateRow: templateRow
  A CBS template row object.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityCBSTemplateCodeInput",
    "required":[
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "cbsCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The code value of the CBS code. The code may have one or more segments according the ot the segment definition.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "isActive":{
            "type":"boolean",
            "description":"The active field indicates whether the CBS code is active for use.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of the parent CBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costType":{
            "type":"string",
            "description":"The category of the cost breakdown structure code. <br />Expense: Represents an expense. <br />Capital: Represents capital. <br />None: Type is not divided into expense or capital. None is selected by default if no other choice is made.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CAPITAL",
                "EXPENSE",
                "NONE"
            ]
        },
        "templateRow":{
            "description":"A CBS template row object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityCBSTemplateRowInput"
                }
            ]
        },
        "cbsTemplateId":{
            "type":"integer",
            "description":"The unique identifier for the CBS template.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownStatus":{
            "type":"boolean",
            "description":"The push down status of a cbs template code. May be manual or automatic.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentCBSCodes":{
            "type":"array",
            "description":"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.",
            "writeOnly":true,
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "writeOnly":true,
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "description":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The name of the CBS Code.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cbsTemplateCodeId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "copiedFromItemId":{
            "type":"integer",
            "description":"The unique identifier for the CBS template that the CBS was copied from.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "description":"This entity represents a CBSTemplateCode object, a unique CBSTemplateCode object can be identified by the following combinations of the fields.<ul><li>cbsTemplateCodeId</li><li>cbsCode,workspaceId</li><li>cbsCode,workspaceCode</li>",
    "exampleSetFlag":false
}

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

• Array of: string

{
    "type":"array",
    "description":"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.",
    "writeOnly":true,
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "writeOnly":true,
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : templateRow

A CBS template row object.

Match All

A CBS template row object.

Show Source

• object ApiEntityCBSTemplateRowInput
  Title: ApiEntityCBSTemplateRowInput

{
    "description":"A CBS template row object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityCBSTemplateRowInput"
        }
    ]
}

Nested Schema : ApiEntityCBSTemplateRowInput

Type: object

Title: ApiEntityCBSTemplateRowInput

Show Source

• configuredFields: array configuredFields
  An object containing configured fields in the form of key-value pairs.

{
    "title":"ApiEntityCBSTemplateRowInput",
    "type":"object",
    "properties":{
        "configuredFields":{
            "type":"array",
            "description":"An object containing configured fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCBSTemplateRowConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : configuredFields

Type: array

An object containing configured fields in the form of key-value pairs.

Show Source

• Array of: object ApiEntityCBSTemplateRowConfiguredFieldValueInput
  Title: ApiEntityCBSTemplateRowConfiguredFieldValueInput

  This entity represents a CBSTemplateRowConfiguredFieldValue object, a unique CBSTemplateRowConfiguredFieldValue object can be identified by the following combinations of the fields.

  • workspaceCostSheetConfiguredValueId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "type":"array",
    "description":"An object containing configured fields in the form of key-value pairs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCBSTemplateRowConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCBSTemplateRowConfiguredFieldValueInput

Type: object

Title: ApiEntityCBSTemplateRowConfiguredFieldValueInput

This entity represents a CBSTemplateRowConfiguredFieldValue object, a unique CBSTemplateRowConfiguredFieldValue object can be identified by the following combinations of the fields.

• workspaceCostSheetConfiguredValueId
• columnDefinitionId
• columnName
• columnLabel

Show Source

• 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: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• costSheetRowId: integer (int64)
  The system-generated identifier for an CBS Code assigned to the line item.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• 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: 4000

  This holds values for Boolean, List and Text type configured fields.
• workspaceCostSheetConfiguredFieldValueId: integer (int64)
  The unique identifier for the Workspace Cost Sheet Configured Field.

{
    "title":"ApiEntityCBSTemplateRowConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "workspaceCostSheetConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Workspace Cost Sheet Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costSheetRowId":{
            "type":"integer",
            "description":"The system-generated identifier for an CBS Code assigned to the line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnLabel":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "textValue":{
            "maxLength":4000,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a CBSTemplateRowConfiguredFieldValue object, a unique CBSTemplateRowConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>workspaceCostSheetConfiguredValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Examples

Select an example Update a Workspace by Removing a Configured Field Update a Workspace CBS Code Using CBS Template Code ID Update a Workspace CBS to Assign a Boolean Configured Field

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request.

Back to Top