Jump to

• Request
• Response

Update a PBS

put

/api/restapi/pbs

Send a request to this endpoint to update a PBS. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - 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.

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

{
    "title":"ApiEntityPBSInput",
    "required":[
        "pbsCode",
        "pbsName",
        "projectId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "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"
            ]
        }
    },
    "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"
    ]
}

Examples

Select an example Update a PBS using PBS ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the PBS service. Verify the request contains valid data, then resubmit the request.

Back to Top