v1

latestOpenAPI 3.0.02026-07-2417611.8 MB

Authoring renditions

Retrieve all renditions in the database.

Use this endpoint to list all the renditions in the database.<br />User roles: admin, manager, editor, viewer

get/authoring/v1/renditions

Query parameters

offsetinteger

Use the offset parameter to specify the number of renditions to skip from the beginning of the list and return the rest.

limitinteger

Set the limit for the maximum number of renditions to return in a single result.

fieldsstring[]

Only the rendition fields that are specified here are returned for each result. Any renditions field is a valid value and these can be specified in a comma-separated list. For example, to list the renditions fields name and ID, provide the value ID, and name. All renditions fields are returned by default.

includestring[]

Additional renditions fields that are specified here are returned. Currently, only the links field can be included. Fields are to be provided as a comma-separated list.

Response

Successfully lists a paged result view of all the renditions in the database.

limitinteger required

The page size.

offsetinteger required

The number of items to skip from the beginning of the list.

hrefstring required

A link to the current page.

nextstring

A link to the next page. Only shown if a next page exists.

previousstring

A link to the previous page. Only shown if a previous page exists.

Example response

{
  "items": [
    {
      "locationX": 50,
      "locationY": 100,
      "width": 200,
      "height": 200,
      "scale": 1.5,
      "asset": {
        "id": "27c621ed48921b7338b84b4f415cba6b"
      },
      "id": "0a800487f06d71eaf4cffdfde1ab28bc",
      "rev": "2-c839bbb8844549c2e298275c4b2adcb8",
      "resource": "67c621ed48921b7338b84b4f415cba6b",
      "links": {
        "self": {
          "href": "/authoring/v1/renditions/0a800487f06d71eaf4cffdfde1ab28bc"
        },
        "media": {
          "href": "/authoring/v1/resources/67c621ed48921b7338b84b4f415cba6b?resize=1.5xw:1.5xh&crop=200:200;50:100"
        },
        "asset": {
          "href": "/authoring/v1/assets/27c621ed48921b7338b84b4f415cba6b"
        },
        "resource": {
          "href": "/authoring/v1/resources/67c621ed48921b7338b84b4f415cba6b"
        }
      }
    }
  ]
}