Jump to

• Request
• Response

Update a Project CBS Segment

put

/api/restapi/segment/project

This endpoint returns a project CBS segment. 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.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityCBSSheetSegmentInput

Type: object

Title: ApiEntityCBSSheetSegmentInput

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

• cbsSheetSegmentId
• segmentDefinitionName,projectId
• segmentDefinitionName,projectCode,workspaceCode

Show Source

• cbsSheetSegmentId: integer (int64)
  The system-generated identifier of a cost sheet segment. This value should not be provided in create operation request data, however, it is required for update requests.
• copiedFrom: integer (int64)
  The unique identifier of the CBS segment that was copied to create the one being viewed.
• costSheetId: integer (int64)
  The system-generated identifier of a cost sheet.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier of the project.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• segmentDefaultValue: string
  Maximum Length: 60

  A value that is added to the concatenated code by default. This is not a required field.
• segmentDefinitionName(required): string
  Maximum Length: 255

  The name of the level of the cost breakdown structure segment definition.
• segmentSeparator(required): string
  Maximum Length: 10

  The separator determines how the concatenated code is separated. The separator can be a period, space, or hyphen.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

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

{
    "title":"ApiEntityCBSSheetSegmentInput",
    "required":[
        "projectId",
        "segmentDefinitionName",
        "segmentSeparator"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier of the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified unique identifier of the workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The system-generated identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsSheetSegmentId":{
            "type":"integer",
            "description":"The system-generated identifier of a cost sheet segment. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "segmentDefinitionName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the level of the cost breakdown structure segment definition.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "segmentDefaultValue":{
            "maxLength":"60",
            "type":"string",
            "description":"A value that is added to the concatenated code by default. This is not a required field.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "segmentSeparator":{
            "maxLength":"10",
            "type":"string",
            "description":"The separator determines how the concatenated code is separated. The separator can be a period, space, or hyphen.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costSheetId":{
            "type":"integer",
            "description":"The system-generated identifier of a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "copiedFrom":{
            "type":"integer",
            "description":"The unique identifier of the CBS segment that was copied to create the one being viewed.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CBSSheetSegment object, a unique CBSSheetSegment object can be identified by the following combinations of the fields.<ul><li>cbsSheetSegmentId</li><li>segmentDefinitionName,projectId</li><li>segmentDefinitionName,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Update a Project CBS Segment Using CBS Sheet Segment ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the CBS Segment resource.

Back to Top