Dimensions

Update item in dimension.

This endpoint modifies an item for dimension identified by id.

put/dimensions/{dimensionId}/items

Request

  • Base URL: https://pts-api.procountor.com/api
  • URL: https://pts-api.procountor.com/api/dimensions/{dimensionId}/items
  • Auth: HTTP bearer

Path parameters

dimensionIdinteger required

Dimension identifier

Request body

idinteger

Dimension item ID. Required in PUT

codeNamestring required

Dimension item code name.

statusstring

Dimension item status. If the dimension item is marked as active, this property is not present. If the dimension item is inactive, the value of this is property is "P".

descriptionstring

Dimension item description.

externalIdstring

Dimension item external ID (free text, max 255 characters). Only returned and persisted for users with the VALUEFRAME_EXPORT special right; otherwise omitted on read and left unchanged on write.

Response

The dimension was successfully updated.

idinteger

Dimension item ID. Required in PUT

codeNamestring required

Dimension item code name.

statusstring

Dimension item status. If the dimension item is marked as active, this property is not present. If the dimension item is inactive, the value of this is property is "P".

descriptionstring

Dimension item description.

externalIdstring

Dimension item external ID (free text, max 255 characters). Only returned and persisted for users with the VALUEFRAME_EXPORT special right; otherwise omitted on read and left unchanged on write.

Changes

No recorded changes to this operation across all 1 revision of this API.