The media endpoint consists of the following distinct endpoints:

Endpoint for images with crops and width

The first endpoint to request images provides access to all existing crops plus its width. The structure of the URI template is as follows:

/caas/v1/media/{mediaId}/{propertyName}/{hash}/{cropName}/{width}</code>

Crop name and width can be retrieved along with the query for the uriTemplate and must replace the placeholders 'cropName' and 'width'. Trying to request non-existing crop names or width will result in an HTTP 404 Not Found Error.

Endpoint for images with crops and width, format transformation and SEO file name

The second endpoint to request images additionally supports image format transformation and SEO friendly file naming. The structure of the URI template is as follows:

/caas/v1/media/{mediaId}/{propertyName}/{hash}/{cropName}/{width}/{filename}

The file name, including one of the supported image formats, can simply be appended to the endpoint above. Currently supported image formats are 'jpg', 'jpeg', 'png' and 'gif'. Requesting an unsupported format, for example, 'webp' will result in an HTTP 400 Bad Request Error. The file name can actually be anything, since the image is identified by its hash and crop name. This allows naming images following a SEO-friendly approach.

Endpoint for generic media files

The third endpoint is the most generic. It provides access to any media file which is managed by the CMS. The structure of the URI template is as follows:

/caas/v1/media/{mediaId}/{propertyPath}/{hash}

You can comfortably explore the described endpoints using the Swagger UI provided with the overview page.

Placeholders of the media endpoints