Create a Workspace CBS Segment
post
/api/restapi/segment/workspaceSegment
Send a request to this endpoint to create a workspace CBS segment. An application object will be created using the JSON data provided in the request body.
Request
There are no request parameters for this operation.
Supported Media Types
- 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.
Show Source
- cbsTemplateSegmentId
- segmentDefinitionName,workspaceId
- segmentDefinitionName,workspaceCode
-
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.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityCBSTemplateSegment
Type:
object
Title:
Show Source
ApiEntityCBSTemplateSegment
-
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.
400 Response
Invalid input for the CBS Segment resource.