v1

latestOpenAPI 3.0.02026-07-2417611.8 MB

Authoring changes

Bulk retire items.

Use the /changes/status/retire endpoint to change the status of multiple items to the retired state. Currently, only Assets and Content support workflow states. For examples of request, see the documentation for changes/status/ready endpoint. <br />User roles: admin, manager, editor

post/authoring/v1/changes/status/retire

Request body

Example request

{
  "ids": [
    {
      "id": "579c2232-7398-4c8b-921d-3932bfc45d19",
      "classification": "content",
      "rev": "2-c39187c4e3c5a69fb6a2b989aaf48330"
    }
  ]
}

Response

See the status field to determine whether the request was successful.

status'success' | 'partial' | 'failure'

Represents the success of the request.

missingstring[]

These are dependencies of items that were requested. The operation should be repeated with these items also included. The format of the ids is the uid format with the classification and id combined.

genericErrorsstring[]

These are items that failed for system are not actionable directly by the API user. They may indicate system errors and also dependent errors i.e. where the item failed because its dependency failed. The format of the ids is the uid format with the classification and id combined.

userErrorsstring[]

These are items that failed for breaking various rules that make the operation valid. These are the actionable errors. The format of the ids is the uid format with the classification and id combined.

successfulstring[]

Even when there are failures some items can succeed, this is the list of ids that succeeded. The format of the ids is the uid format with the classification and id combined.

messagesobject

Example response

{
  "missing": [
    "content:a",
    "content:b"
  ],
  "genericErrors": [
    "content:c",
    "content:d"
  ],
  "userErrors": [
    "content:e",
    "content:f"
  ],
  "successful": [
    "content:g",
    "content:h"
  ]
}