Show Source

• [0]: object ApiEntityCBSTemplateSegment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityCBSTemplateSegment"
    }
}

Show Source

• copiedFrom(optional): integer(int64)
  The unique identifier for the original CBS segment.
• link(optional): string(url)
  Read Only: true
• segmentDefaultValue(optional): string
  A value that is added to the concatenated code by default. This is not a required field.
• segmentDefinitionName: string
  The name of the CBS segment.
• segmentId(optional): 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.
• segmentSeparator(optional): string
  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(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "segmentDefinitionName",
        "templateId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "segmentSeparator":{
            "type":"string",
            "description":"The separator determines how the concatenated code is separated. The separator can be a period, space, or hyphen."
        },
        "segmentDefaultValue":{
            "type":"string",
            "description":"A value that is added to the concatenated code by default. This is not a required field."
        },
        "segmentDefinitionName":{
            "type":"string",
            "description":"The name of the CBS segment."
        },
        "copiedFrom":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the original CBS segment."
        },
        "segmentId":{
            "type":"integer",
            "format":"int64",
            "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."
        },
        "templateId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the CBS template."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}