Create a PBS
post
/api/restapi/pbs
Send a request to this endpoint to create a PBS. 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 : ApiEntityPBSInput
Type:
object
Title:
ApiEntityPBSInput
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)Read Only:true
Deprecated. As of 24.5.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(required): 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(required): 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(required): 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)Read Only:true
Deprecated. As of 24.5.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root 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.
400 Response
Invalid input for the PBS service. Verify the request contains valid data, then resubmit the request.