Jump to

• Request
• Response

Update a Project CBS Code by CBS

put

/api/restapi/cbs/project

Send a request to this endpoint to update a project 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 : 'cbsSheetCodeId'

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityCBSSheetCodeInput

Type: object

Title: ApiEntityCBSSheetCodeInput

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

• cbsSheetCodeId
• cbsCode,projectId
• cbsCode,projectCode,workspaceCode

Show Source

• cbsCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.
• cbsSheetCodeId: integer (int64)
  The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition. This value should not be provided in create operation request data, however, it is required for update requests.
• costSheetId: integer (int64)
  The unique identifier of a cost sheet.
• costSheetRow: costSheetRow
  A CBS sheet row object.
• 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 system-generated identifier of a parent cost item in a cost sheet.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of a project.
• projectId(required): integer (int64)
  The unique identifier for the project.
• sourceId: string
  Maximum Length: 255

  The unique identifier of cost sheet item data in an external source.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The system-generated identifier of a workspace.

{
    "title":"ApiEntityCBSSheetCodeInput",
    "required":[
        "cbsCode",
        "projectId"
    ],
    "type":"object",
    "properties":{
        "costSheetId":{
            "type":"integer",
            "description":"The unique identifier of a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsSheetCodeId":{
            "type":"integer",
            "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costSheetRow":{
            "description":"A CBS sheet row object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityCBSSheetRowInput"
                }
            ]
        },
        "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 system-generated identifier of a parent cost item in a cost sheet.",
            "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"
            ]
        },
        "sourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of cost sheet item data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified identifier of a project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The system-generated identifier of a workspace.",
            "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"
            ]
        }
    },
    "description":"This entity represents a CBSSheetCode object, a unique CBSSheetCode object can be identified by the following combinations of the fields.<ul><li>cbsSheetCodeId</li><li>cbsCode,projectId</li><li>cbsCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : costSheetRow

A CBS sheet row object.

Match All

A CBS sheet row object.

Show Source

• object ApiEntityCBSSheetRowInput
  Title: ApiEntityCBSSheetRowInput

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

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 : ApiEntityCBSSheetRowInput

Type: object

Title: ApiEntityCBSSheetRowInput

Show Source

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

{
    "title":"ApiEntityCBSSheetRowInput",
    "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/ApiEntityCBSSheetRowConfiguredFieldValueInput",
                "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 ApiEntityCBSSheetRowConfiguredFieldValueInput
  Title: ApiEntityCBSSheetRowConfiguredFieldValueInput

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

  • costSheetRowConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

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

Nested Schema : ApiEntityCBSSheetRowConfiguredFieldValueInput

Type: object

Title: ApiEntityCBSSheetRowConfiguredFieldValueInput

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

• costSheetRowConfiguredFieldValueId
• 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.
• costSheetRowConfiguredFieldValueId: integer (int64)
  The unique identifier for the Project Cost Sheet Configured Field.
• costSheetRowId: integer (int64)
  The system-generated identifier of a CBS Code.
• 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.

{
    "title":"ApiEntityCBSSheetRowConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "costSheetRowConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Project Cost Sheet Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costSheetRowId":{
            "type":"integer",
            "description":"The system-generated identifier of a CBS Code.",
            "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 CBSSheetRowConfiguredFieldValue object, a unique CBSSheetRowConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>costSheetRowConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Examples

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

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