/
[GET] /thumbnail/{fileIndex}

[GET] /thumbnail/{fileIndex}

/api/dms/objects/{objectId}/contents/renditions/thumbnail/{fileIndex}?size={size}

Description

To retrieve a preview thumbnail of the first page from the content with the given index attached to the DMS object.
At the moment no E-Mail attachments are included or can be requested within this endpoint.
The endpoint can responed three HTTP Statuscodes:

  • HTTP 200 → The Thumbnail is in the payload

  • HTTP 404 → The Thumbnail is not yet ready by the rendition. Try is shortly again.

  • HTTP 422 → The Thumbnail can't be provided by the rendition.

The {fileIndex} is one based. For the first content document insert a 1 and for the following one 2, 3, 4, ... if it is a object type with multiple content files attached.
The {size} parameter is optional. If it is not specified a default size of 96px is returned.

Please remind, the rendition creates by default thumbnails in the size of 96px. If you request another size, the rendition is every time triggered to create it up on your request which need more resources at the rendition service.

Request
Method

GET

Response
Format

image/png

Minimum Version

5.0.0

Request
Example

/api/dms/objects/2563/contents/renditions/thumbnail/1
/api/dms/objects/2563/contents/renditions/thumbnail/1?size=100

Result
Example

A byte sequence of the thumbnail file if the HTTP statuscode is 200. If the HTTP statuscode is 400+ then no payload is present.

 

Related content