Update a Scope Item

put

/api/restapi/scopeItem

Send a request to this endpoint to update a scope item.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : ApiEntityScopeItemInput
Type: object
Title: ApiEntityScopeItemInput
This entity represents a ScopeItem object, a unique ScopeItem object can be identified by the following combinations of the fields.
  • scopeItemId
  • scopeItemCode,pbsId,projectId
  • scopeItemCode,pbsCodeHierarchy,projectId
  • scopeItemCode,pbsId,projectCode,workspaceCode
  • scopeItemCode,pbsCodeHierarchy,projectCode,workspaceCode
Show Source
Nested Schema : cbsCodes
Type: array
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. 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.
Show Source
Nested Schema : configuredFields
Type: array
The list of configured fields for a scope item.
Show Source
  • ApiEntityScopeItemConfiguredFieldValueInput
    Title: ApiEntityScopeItemConfiguredFieldValueInput
    This entity represents a ScopeItemConfiguredFieldValue object, a unique ScopeItemConfiguredFieldValue object can be identified by the following combinations of the fields.
    • scopeItemConfiguredFieldValueId
    • columnDefinitionId
    • columnName
    • columnLabel
Nested Schema : pbsCodeHierarchy
Type: array
The list of PBS codes in hierarchical way.
Show Source
Nested Schema : scopeItemCodeValue
Type: array
The list of code values for a scope item. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
  • ApiEntityCodeValueScopeItemInput
    Title: ApiEntityCodeValueScopeItemInput
    This entity represents a CodeValueScopeItem object, a unique CodeValueScopeItem object can be identified by the following combinations of the fields.
    • codeValueScopeItemId
    • 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 : ApiEntityScopeItemConfiguredFieldValueInput
Type: object
Title: ApiEntityScopeItemConfiguredFieldValueInput
This entity represents a ScopeItemConfiguredFieldValue object, a unique ScopeItemConfiguredFieldValue object can be identified by the following combinations of the fields.
  • scopeItemConfiguredFieldValueId
  • 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.
  • This holds values for Date type configured fields.
  • 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.
  • The unique identifier for the Scope Item Configured Field.
  • The system-generated identifier of a Scope Item.
  • Maximum Length: 4000
    This holds values for Boolean, List and Text type configured fields.
Nested Schema : ApiEntityCodeValueScopeItemInput
Type: object
Title: ApiEntityCodeValueScopeItemInput
This entity represents a CodeValueScopeItem object, a unique CodeValueScopeItem object can be identified by the following combinations of the fields.
  • codeValueScopeItemId
  • 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
Examples

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input.
Back to Top