Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring renditions

Retrieve all renditions created within the specified date range.

Use this endpoint to retrieve all renditions that was created within the date range specified.<br />User roles: admin, manager, editor, viewer

get/authoring/v1/renditions/views/by-created

Query parameters

startstring date-time

Provide the date and time of when the rendition was created. Renditions that were created on or after this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.

endstring date-time

Provide the date and time of when the rendition was created. Renditions that were created on or before this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.

fieldsstring

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

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. The default value is 50.

order'ascending' | 'descending'

Specify whether you want the renditions to be returned in ascending or descending order. Documents are returned in descending order by default.

Response

Successfully lists a paged result view of all renditions that was created within the date range specified.

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"
        }
      }
    }
  ]
}