Retrieve renditions for a specified entity

Request

Retrieves information about renditions that exist for a specified entity, including their gateway links and delivery links. Renditions can be filtered by area of use or by their rendition link name, or both.

Security

OAuth2

Path

entityIdinteger, (int64)required

The unique identifier of the entity.

Body

The filter for the renditions.

rendition_link_namesArray of strings or null

The names of the rendition links to return if they exist on the entity.

areas_of_useArray of strings or null

The area of use of the rendition links to return. For example, the area of use Download will return all existing renditions that are available for the download component. See the RenditionLinkIntendedAreaOfUse option list for all available values.

curl -i -X POST \
  'https://your-server/api/entities/{entityId}/v2.0/renditions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "rendition_link_names": [
      "string"
    ],
    "areas_of_use": [
      "string"
    ]
  }'

Responses

Successful operation

Bodyapplication/json

entity_idinteger, (int64)

The unique identifier for the targeted entity.

renditionsArray of objects or null(RenditionsResource)

Collection of renditions metadata.

selfobject(Link)

Represents a link to a resource.

Response

{
  "entity_id": 0,
  "renditions": [
    { … }
  ],
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  }
}