Jump to

• Request
• Response

Update a WBS

put

/api/restapi/wbs

Send a request to this endpoint to update a WBS.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityWBSInput

Type: object

Title: ApiEntityWBSInput

This entity represents a WBS object, a unique WBS object can be identified by the following combinations of the fields.

• wbsId
• wbsCode,projectId,parentId
• wbsCode,projectCode,workspaceCode,parentId
• wbsCode,projectCode,workspaceCode,parentWBSCodes
• wbsCode,projectId,parentWBSCodes

Show Source

• codeValues: array codeValues
  The list of code values for a WBS. This entity can only be used to assign codeValues or create codeValues on the fly.
• configuredFields: array configuredFields
  The list of configured fields for a WBS.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  A summary of the purpose for the WBS.
• managerId: integer (int64)
  The system-generated identifier of manager or person responsible for monitoring and providing status on the WBS.
• parentId: integer (int64)
  The system-generated identifier of the parent WBS.
• parentWBSCodes: array parentWBSCodes
  The list of parent WBS codes in the hierarchy of a WBS. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs. If required, the field 'wbsPath' can be referred to get the value for the parent WBS path.
• 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 WBS.
• wbsCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the WBS.
• wbsId: integer (int64)
  Unique identifier of the WBS.
• wbsName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the WBS.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityWBSInput",
    "required":[
        "projectId"
    ],
    "type":"object",
    "properties":{
        "parentWBSCodes":{
            "type":"array",
            "description":"The list of parent WBS codes in the hierarchy of a WBS. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs. If required, the field 'wbsPath' can be referred to get the value for the parent WBS path.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"A summary of the purpose for the WBS.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a WBS.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWBSConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The system-generated identifier of the parent WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "managerId":{
            "type":"integer",
            "description":"The system-generated identifier of manager or person responsible for monitoring and providing status on the WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "wbsId":{
            "type":"integer",
            "description":"Unique identifier of the WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The sequence number of a WBS.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "wbsCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified unique identifier for the WBS.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "wbsName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the WBS.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValues":{
            "type":"array",
            "description":"The list of code values for a WBS. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueWBSInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "description":"This entity represents a WBS object, a unique WBS object can be identified by the following combinations of the fields.<ul><li>wbsId</li><li>wbsCode,projectId,parentId</li><li>wbsCode,projectCode,workspaceCode,parentId</li><li>wbsCode,projectCode,workspaceCode,parentWBSCodes</li><li>wbsCode,projectId,parentWBSCodes</li>",
    "exampleSetFlag":false
}

Nested Schema : codeValues

Type: array

The list of code values for a WBS. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueWBSInput
  Title: ApiEntityCodeValueWBSInput

  This entity represents a CodeValueWBS object, a unique CodeValueWBS object can be identified by the following combinations of the fields.

  • codeValueWbsId
  • codeValueId
  • codeTypeId,codeValueCode
  • codeTypeCode,codeValueCode
  • codeTypeCode,parentId,codeValueCode
  • codeValueCode,codeTypeId,parentId
  • codeTypeCode,codeValueCode,projectCode
  • codeTypeCode,codeValueCode,projectId
  • codeTypeCode,codeValueCode,parentId,projectCode
  • codeTypeCode,codeValueCode,parentId,projectId

{
    "type":"array",
    "description":"The list of code values for a WBS. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueWBSInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a WBS.

Show Source

• Array of: object ApiEntityWBSConfiguredFieldValueInput
  Title: ApiEntityWBSConfiguredFieldValueInput

  This entity represents a WBSConfiguredFieldValue object, a unique WBSConfiguredFieldValue object can be identified by the following combinations of the fields.

  • wbsConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "type":"array",
    "description":"The list of configured fields for a WBS.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWBSConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : parentWBSCodes

Type: array

The list of parent WBS codes in the hierarchy of a WBS. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs. If required, the field 'wbsPath' can be referred to get the value for the parent WBS path.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of parent WBS codes in the hierarchy of a WBS. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs. If required, the field 'wbsPath' can be referred to get the value for the parent WBS path.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCodeValueWBSInput

Type: object

Title: ApiEntityCodeValueWBSInput

This entity represents a CodeValueWBS object, a unique CodeValueWBS object can be identified by the following combinations of the fields.

• codeValueWbsId
• codeValueId
• codeTypeId,codeValueCode
• codeTypeCode,codeValueCode
• codeTypeCode,parentId,codeValueCode
• codeValueCode,codeTypeId,parentId
• codeTypeCode,codeValueCode,projectCode
• codeTypeCode,codeValueCode,projectId
• codeTypeCode,codeValueCode,parentId,projectCode
• codeTypeCode,codeValueCode,parentId,projectId

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete code value assigned to the object.
• codeTypeCode: string
  Minimum Length: 0

  Maximum Length: 60

  This field displays the name of a code or value.
• codeTypeId(required): integer (int64)
  The unique identifier for the code type.The code type object can also be identified by its unique criteria.
• codeValueCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the code value.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code value.
• codeValueWbsId: integer (int64)
  The unique identifier of a WBS code value.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The code of a Project of a Project CodeType.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• wbsId: integer (int64)
  The unique identifier of a WBS.

{
    "title":"ApiEntityCodeValueWBSInput",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "codeValueWbsId":{
            "type":"integer",
            "description":"The unique identifier of a WBS code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "wbsId":{
            "type":"integer",
            "description":"The unique identifier of a WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "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 code of a Project of a Project CodeType.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CodeValueWBS object, a unique CodeValueWBS object can be identified by the following combinations of the fields.<ul><li>codeValueWbsId</li><li>codeValueId</li><li>codeTypeId,codeValueCode</li><li>codeTypeCode,codeValueCode</li><li>codeTypeCode,parentId,codeValueCode</li><li>codeValueCode,codeTypeId,parentId</li><li>codeTypeCode,codeValueCode,projectCode</li><li>codeTypeCode,codeValueCode,projectId</li><li>codeTypeCode,codeValueCode,parentId,projectCode</li><li>codeTypeCode,codeValueCode,parentId,projectId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityWBSConfiguredFieldValueInput

Type: object

Title: ApiEntityWBSConfiguredFieldValueInput

This entity represents a WBSConfiguredFieldValue object, a unique WBSConfiguredFieldValue object can be identified by the following combinations of the fields.

• wbsConfiguredFieldValueId
• columnDefinitionId
• columnName
• columnLabel

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• wbsConfiguredFieldValueId: integer (int64)
  The unique identifier for the WBS Configured Field.
• wbsId: integer (int64)
  Unique identifier of the WBS.

{
    "title":"ApiEntityWBSConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "wbsConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the WBS Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "wbsId":{
            "type":"integer",
            "description":"Unique identifier of the WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "textValue":{
            "maxLength":4000,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a WBSConfiguredFieldValue object, a unique WBSConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>wbsConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Examples

Select an example Update a WBS Update a WBS by Assigning Hierarchical Code Values Using Codes Update a WBS by Assigning Multiple Code Values Using IDs Update a WBS by Assigning Code Values Using IDs Update a WBS to Assign a Boolean Configured Field Update a WBS by Removing a Configured Field Update a WBS by Assigning Code Values Using Codes

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the WBS service.

Back to Top