Entities

Retrieve renditions for a specified entity

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.

post/api/entities/{entityId}/renditions

Request

Base URL
https://your-server
Auth
OAuth 2
Authorization code/oauth/authorize
Token URL/oauth/token
TypeScript
https://skmtc.dev/sitecore/apis/entities-api/docs/api/entities/:entityId/renditions/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

entityIdinteger required

The unique identifier of the entity.

Request body

rendition_link_namesstring[] nullable

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

areas_of_usestring[] nullable

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.

Response

Successful operation

entity_idinteger

The unique identifier for the targeted entity.

Changes

No recorded changes to this operation across all 1 revision of this API.