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
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
    The list of code values for a WBS. This entity can only be used to assign codeValues or create codeValues on the fly.
  • configuredFields
    The list of configured fields for a WBS.
  • Minimum Length: 0
    Maximum Length: 4000
    A summary of the purpose for the WBS.
  • Deprecated. As of 23.11.
    Indicates whether or not the WBS is marked for deletion.
  • The system-generated identifier of manager or person responsible for monitoring and providing status on the WBS.
  • Minimum Length: 1
    Maximum Length: 60
    Deprecated. As of 23.11.
    The user-specified identifier of the parent of a WBS.
  • The system-generated identifier of the parent WBS.
  • 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.
  • Minimum Length: 1
    Maximum Length: 60
    The unique identifier for a project set by the user who created the project.
  • The unique identifier for the project.The project object can also be identified by its unique criteria.
  • The sequence number of a WBS.
  • Read Only: true
    Deprecated. As of 23.10.
    Date when the record was last updated.
  • Minimum Length: 1
    Maximum Length: 60
    The user-specified unique identifier for the WBS.
  • Unique identifier of the WBS.
  • Minimum Length: 1
    Maximum Length: 255
    The name of the WBS.
  • Read Only: true
    Maximum Length: 4000
    Deprecated. As of 23.11.
    The complete path to the WBS. This is the hierarchy path from the Project Code to the WBS. It is based on the following pattern: <ProjectCode>.<WSBCode>.<WSBCode>...<WBSCode>. For example, for a project with code 'P1' having the WBS hierarchy as 'WBS1', 'WBS2', and 'WBS3', the wbsPath for 'WBS3' will be defined as 'P1.WBS1.WBS2.WBS3'.
  • Minimum Length: 0
    Maximum Length: 60
    The user-specified identifier of a workspace.
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
  • 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
Nested Schema : configuredFields
Type: array
The list of configured fields for a WBS.
Show Source
  • 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
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
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
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
  • Allowed Values: [ "DELETE" ]
    Provide value for this field during object update to delete the assigned configured field value.
  • Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column label.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column name.
  • Read Only: true
    Deprecated. As of 23.10.
    This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
  • Read Only: true
    Deprecated. As of 23.10.
    This holds values for Cost type configured fields in the workspace1 currency conversion.
  • Read Only: true
    Deprecated. As of 23.10.
    This holds values for Cost type configured fields in the workspace2 currency conversion.
  • Read Only: true
    Deprecated. As of 23.10.
    This holds values for Cost type configured fields in the workspace3 currency conversion.
  • This holds values for Date type configured fields.
  • Read Only: true
    Maximum Length: 4000
    Deprecated. As of 23.10.
    Provides the error message for why the formula calculation resulted in an error.
  • Read Only: true
    Deprecated. As of 23.10.
    Determines if formula calculation hit an error calculating a value for this field.
  • 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.
  • Maximum Length: 4000
    This holds values for Boolean, List and Text type configured fields.
  • Read Only: true
    Deprecated. As of 23.10.
    Date when the record was last updated.
  • The unique identifier for the WBS Configured Field.
  • Unique identifier of the WBS.
Examples

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the WBS service.
Back to Top