View a PBS by Code
get
/primeapi/restapi/pbs/project/{id}/code/{code}
This endpoint returns PBSs that meet the following requirements:
- The object has a code that matches the value of the {code} path parameter.
Request
Path Parameters
-
code: string
PBS code of the PBS to be found.
-
id: integer(int64)
Project ID of the PBS.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityPBS
Type:
Show Source
object
-
description:
string
Allowed Values:
[ "Length[0-4000]" ]
Additional details for the PBS node. -
link(optional):
string(url)
Read Only:
true
-
parentPbsId(optional):
integer(int64)
The name of the PBS parent of the scope item.
-
pbsCode(optional):
string
Allowed Values:
[ "Length[1-60]" ]
A unique identifier for the PBS node. -
pbsconfiguredFields(optional):
object ApiEntityPBSConfiguredFields
-
pbsId:
integer(int64)
-
pbsName(optional):
string
Allowed Values:
[ "Length[1-255]" ]
The name of the PBS node. -
projectId(optional):
integer(int64)
-
sequenceNumber:
integer(int32)
-
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.
Nested Schema : ApiEntityPBSConfiguredFields
Type:
Show Source
object
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost fields in the form of key-value pairs.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing non-cost, non-text fields in the form of key-value pairs.
-
pbs(optional):
object ApiEntityPBS
-
pbsId(optional):
integer(int64)
The system-generated identifier of a PBS.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
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.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing cost fields in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing non-cost, non-text fields in the form of key-value pairs.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing text fields in the form of key-value pairs.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
204 Response
Successful operation with no content.
404 Response
The requested PBS does not exist, or you do not have access to it.