Jump to

• Request
• Response

Update a Workspace CBS Segment

put

/api/restapi/segment/workspace

Send a request to this endpoint to update a CBS segment.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityCBSTemplateSegmentInput

Type: object

Title: ApiEntityCBSTemplateSegmentInput

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

• cbsTemplateSegmentId
• segmentDefinitionName,workspaceId
• segmentDefinitionName,workspaceCode

Show Source

• cbsTemplateSegmentId: integer (int64)
  The unique identifier for the CBS 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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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 CBS segment.
• segmentSeparator(required): string
  Maximum Length: 10

  The separator determines how the concatenated code is separated. The separator can be a period, space, or hyphen.
• templateId: integer (int64)
  The unique identifier for the CBS template.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

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

{
    "title":"ApiEntityCBSTemplateSegmentInput",
    "required":[
        "segmentDefinitionName",
        "segmentSeparator",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "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 unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "templateId":{
            "type":"integer",
            "description":"The unique identifier for the CBS template.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "segmentDefinitionName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the CBS segment.",
            "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"
            ]
        },
        "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"
            ]
        },
        "cbsTemplateSegmentId":{
            "type":"integer",
            "description":"The unique identifier for the CBS 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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CBSTemplateSegment object, a unique CBSTemplateSegment object can be identified by the following combinations of the fields.<ul><li>cbsTemplateSegmentId</li><li>segmentDefinitionName,workspaceId</li><li>segmentDefinitionName,workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Update a Workspace CBS Segment Using CBS Template 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