View all Project CBS Segments by Project ID
get
/api/restapi/segment/project/{projectId}
This endpoint returns workspace CBS segments that meet the following requirements:
- The object is associated with a project with an ID value that matches the value of the {projectId} path parameter. A CBS is used to track, manage, and report costs related to a project.
Request
Path Parameters
-
projectId(required): integer(int64)
The system-generated identifier of a project.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
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.
204 Response
Successful operation with no content.
404 Response
The requested object does not exist, or you do not have access to it.