Jump to

• Request
• Response

View All Children in a PBS Hierarchy

get

/api/restapi/pbs/{pbsId}/childrenHierarchy

This endpoint returns all children of PBSs that meet the following requirements:

• The object has an ID that matches the value of the {pbsId} path parameter.

Request

Path Parameters

• pbsId(required): integer(int64)
  Returns the PBS that are children in the hierarchy of the specified PBS ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityPBS>

Type: array

Title: List<ApiEntityPBS>

Show Source

• 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

{
    "title":"List<ApiEntityPBS>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityPBS",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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.

• pbsId
• pbsCode,projectId
• pbsCode,projectCode,workspaceCode

Show Source

• 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.

{
    "title":"ApiEntityPBS",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The sequence number of a PBS.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Additional details for the PBS node.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The name of the PBS parent of the scope item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pbsId":{
            "type":"integer",
            "description":"The system-generated identifier of the PBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pbsName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the PBS node.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "pbsCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"A unique identifier for the PBS node.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "pbsCodeHierarchy":{
            "type":"array",
            "description":"The list of PBS codes in hierarchical way.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a PBS object, a unique PBS object can be identified by the following combinations of the fields.<ul><li>pbsId</li><li>pbsCode,projectId</li><li>pbsCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : pbsCodeHierarchy

Type: array

The list of PBS codes in hierarchical way.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of PBS codes in hierarchical way.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

204 Response

Successful operation with no content.

404 Response

The requested PBS does not exist, or you do not have access to it.

Back to Top