Jump to

• Request
• Response

View a Workspace CBS Segment

get

/api/restapi/segment/workspaceSegment/{cbsTemplateSegmentId}

This endpoint returns workspace CBS segments that meet the following requirements:

• The object has an ID that matches the value of the {cbsTemplateSegmentId} path parameter.

Request

Path Parameters

• cbsTemplateSegmentId(required): integer(int64)
  The system-generated identifier of a CBS segment.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the workspace CBS segment for the specified workspace CBS segment Id

Body ()

Root Schema : ApiEntityCBSTemplateSegment

Type: object

Title: ApiEntityCBSTemplateSegment

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: string
  Maximum Length: 255

  The name of the CBS segment.
• segmentSeparator: 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: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityCBSTemplateSegment",
    "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"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested object does not exist, or you do not have access to it.

Back to Top