Create a Workspace Segment
post
/primeapi/restapi/segment/workspace/{id}
Send a request to this endpoint to create a workspace segment. An application object will be created using the JSON data provided in the request body.
Request
Supported Media Types
- application/json
Path Parameters
-
id: integer(int64)
UNDEFINED
A CBS segment object.
Root Schema : ApiEntityCBSTemplateSegment
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityCBSTemplateSegment
Type:
Show Source
object
-
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.
400 Response
Invalid input for the Segment resource.