View a PBS by Project
get
/api/restapi/pbs/project/{projectId}
This endpoint returns PBSs that meet the following requirements:
- The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
Request
Path Parameters
-
projectId(required): integer(int64)
Project ID of the PBS.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityPBS>
Type:
array
Title:
Show Source
List<ApiEntityPBS>
-
Array of:
object ApiEntityPBS
Title:
ApiEntityPBS
This entity represents a PBS object, a unique PBS object can be identified by the following combinations of the fields.- pbsId
- pbsCode,projectId
- pbsCode,projectCode,workspaceCode
Nested Schema : ApiEntityPBS
Type:
object
Title:
ApiEntityPBS
This entity represents a PBS object, a unique PBS object can be identified by the following combinations of the fields.
Show Source
- pbsId
- pbsCode,projectId
- pbsCode,projectCode,workspaceCode
-
description: string
Minimum Length:
0
Maximum Length:4000
Additional details for the PBS node. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
parentId: integer
(int64)
The name of the PBS parent of the scope item.
-
pbsCode: string
Minimum Length:
1
Maximum Length:60
A unique identifier for the PBS node. -
pbsCodeHierarchy: array
pbsCodeHierarchy
The list of PBS codes in hierarchical way.
-
pbsId: integer
(int64)
The system-generated identifier of the PBS.
-
pbsName: string
Minimum Length:
1
Maximum Length:255
The name of the PBS node. -
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
sequenceNumber: integer
(int32)
The sequence number of a PBS.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
204 Response
Successful operation with no content.
404 Response
The requested PBS does not exist, or you do not have access to it.