Create Multiple Project CBS Segments
post
/api/restapi/segment/projectSegment/batch
Send a request to this endpoint to create one or more CBS Project Segments.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityCBSSheetSegmentInput>
Type:
array
Title:
Show Source
List<ApiEntityCBSSheetSegmentInput>
-
Array of:
object ApiEntityCBSSheetSegmentInput
Title:
ApiEntityCBSSheetSegmentInput
This entity represents a CBSSheetSegment object, a unique CBSSheetSegment object can be identified by the following combinations of the fields.- cbsSheetSegmentId
- segmentDefinitionName,projectId
- segmentDefinitionName,projectCode,workspaceCode
Nested Schema : ApiEntityCBSSheetSegmentInput
Type:
object
Title:
ApiEntityCBSSheetSegmentInput
This entity represents a CBSSheetSegment object, a unique CBSSheetSegment object can be identified by the following combinations of the fields.
Show Source
- cbsSheetSegmentId
- segmentDefinitionName,projectId
- segmentDefinitionName,projectCode,workspaceCode
-
cbsSheetSegmentId: integer
(int64)
The system-generated identifier of a cost sheet 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.
-
costSheetId: integer
(int64)
The system-generated identifier of a cost sheet.
-
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
projectCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier of the project. -
projectId(required): integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
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 level of the cost breakdown structure segment definition. -
segmentSeparator(required): string
Maximum Length:
10
The separator determines how the concatenated code is separated. The separator can be a period, space, or hyphen. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.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 system-generated identifier of a workspace.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : List<ApiEntityCBSSheetSegment>
Type:
array
Title:
Show Source
List<ApiEntityCBSSheetSegment>
-
Array of:
object ApiEntityCBSSheetSegment
Title:
ApiEntityCBSSheetSegment
Nested Schema : ApiEntityCBSSheetSegment
Type:
object
Title:
Show Source
ApiEntityCBSSheetSegment
-
cbsSheetSegmentId: integer
(int64)
The system-generated identifier of a cost sheet 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.
-
costSheetId: integer
(int64)
The system-generated identifier of a cost sheet.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier of the project. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
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 level of the cost breakdown structure segment definition. -
segmentSeparator: string
Maximum Length:
10
The separator determines how the concatenated code is separated. The separator can be a period, space, or hyphen. -
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 system-generated identifier of a workspace.
400 Response
Invalid input for the CBS Segment resource.