Returns the PBS for the specified PBS code.
get
/primeapi/restapi/v16.2/pbs/code/{code}
Request
Path Parameters
- code
-
Type:
stringRequired:trueCode of the PBS to be found.
Response
Supported Media Types
- application/json
200 Response
successful operation
Body
Root Schema : ApiEntityPBS
Type:
object- description
-
Type:
stringRequired:trueAllowed Values:[ "Length[0-4000]" ]Additional details for the PBS node. - parentPbsId
-
Type:
integer(int64)The name of the PBS parent of the scope item. - pbsCode
-
Type:
stringAllowed Values:[ "Length[1-60]" ]A unique identifier for the PBS node. - pbsFlexCost
-
Type:
objectApiEntityPBSFlexCost - pbsFlexOther
-
Type:
objectApiEntityPBSFlexOther - pbsFlexText
-
Type:
objectApiEntityPBSFlexText - pbsId
-
Type:
integer(int64)Required:true - pbsName
-
Type:
stringAllowed Values:[ "Length[1-255]" ]The name of the PBS node. - projectId
-
Type:
integer(int64) - sequenceNumber
-
Type:
integer(int32)Required:true
Nested Schema : ApiEntityPBSFlexCost
Type:
object- flexMap
-
Type:
objectflexMapAdditional Properties Allowed: additionalPropertiesLists all configured cost fields assigned to the PBS with its corresponding value as a (key,value) pair. - pbs
-
Type:
objectApiEntityPBS - pbsId
-
Type:
integer(int64)
Nested Schema : ApiEntityPBSFlexOther
Type:
object- flexMap
-
Type:
objectflexMapAdditional Properties Allowed: additionalPropertiesLists all configured date, number, integer fields assigned to the PBS with its corresponding value as a (key,value) pair. - pbs
-
Type:
objectApiEntityPBS - pbsId
-
Type:
integer(int64)
Nested Schema : ApiEntityPBSFlexText
Type:
object- flexMap
-
Type:
objectflexMapAdditional Properties Allowed: additionalPropertiesLists all configured text fields assigned to the PBS with its corresponding value as a (key,value) pair. - pbs
-
Type:
objectApiEntityPBS - pbsId
-
Type:
integer(int64)
Nested Schema : flexMap
Type:
object-
Type:
objectadditionalProperties
Lists all configured cost fields assigned to the PBS with its corresponding value as a (key,value) pair.
Nested Schema : additionalProperties
Type:
objectNested Schema : flexMap
Type:
object-
Type:
objectadditionalProperties
Lists all configured date, number, integer fields assigned to the PBS with its corresponding value as a (key,value) pair.
Nested Schema : additionalProperties
Type:
objectNested Schema : flexMap
Type:
object-
Type:
objectadditionalProperties
Lists all configured text fields assigned to the PBS with its corresponding value as a (key,value) pair.
Nested Schema : additionalProperties
Type:
object404 Response
The PBS do not exist or you do not have access to it.