Sign in
Classifications

Update Classification

Update an existing classification dimension's name and settings.

put/public/v1/classifications/{classification_id}/

Path parameters

classification_idinteger required

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

idinteger nullable
namestring required
is_activeboolean required
required_for_recordsPublicClassifiableRecords[] required
parent_idinteger nullable required

Response

OK

created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

idinteger required
codestring nullable
required_for_recordsPublicClassifiableRecords[] required
parent_idinteger nullable required
parent_namestring nullable required
namestring required
is_activeboolean

Changes

Changed in 4 of the 27 revisions of this API.15

  • 456ef8c02f621See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • d0cd912ee42d2See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • af0ec77e52771See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

  • 51b71d2b921311See the full diff
    • ●

      added the new statistical_journal enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the new statistical_journal enum value to the request property /

      request-property-enum-value-added

Of the 27 revisions, 1 has no diff computed.