About this resource
Representation of a rendition
Properties
Property | Description | Type |
---|---|---|
extension | The extension of the rendition. | string |
id | Gets the identifier for the rendition. | guid |
metadata | Gets the metadata. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-customrendition' and the value 'Metadata' to your request. | Dictionary of pairs with string keys and string values |
name | Gets the rendition name. | string |
preview | The preview of the rendition. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-rendition' and the value 'Preview' to your request. | string |
publishedUri | Shortcut property to the URI of the published public link of the rendition. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-rendition' and the value 'PublishedUri' to your request. | string |
type | Gets the rendition type. | string (values: original, preset, crop, trim, custom) |
uri | Gets the uri for this rendition. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-rendition' and the value 'Uri' to your request. | string |
Relations
Method | Name | Select-key | Resource type | Description |
---|---|---|---|---|
GET | self | Provides a link to this resource. | ||
GET | publiclinks | select-CustomRendition: publiclinks | PublicLinkCollection | Gets the public links for the rendition |