GET /api/dms/objects/{objectId}/contents/renditions/pdf

As of Version product version 2020 Winter | component version 2020 Winter

Request Method GET

Response Format PDF

Required Permission action read
>> Roles and Role Sets

Description

To return the content file's PDF rendition of the DMS document object, send the request with the ID of the DMS object as objectId.

If the specified objectId does not exist, the call results in the error 404 - Not Found. Further errors are triggered by referencing an object without a content file or with a not convertible content file.

The endpoint accepts the the following target file types for the conversion into PDF format:

Types	Extension	Note
Microsoft Office and Excel file types
MS Office Word 97-2016	doc, docx
MS Office PowerPoint 97-2016	ppt, pptx
MS Office Excel 97-2016	xls, xlsx
OpenDocument Text	odt
OpenDocument Presentation	odp
OpenDocument Spreadsheet	ods
Visio Drawing File	vsd, vsdx	limited range of functions
Image File Types
Tagged Image File Format	tiff / tif
Portable Bitmap Image	pbm
Bitmap Image File	bmp
Graphical Interchange Format File	gif
JPEG Image Exchangeable image file format (JPEG)	jpg, jng, jpeg
Portable Network Graphic	png
Weppy Image Format (Lossy Compression)	webp

Response Header Content-Type: application/pdf

Request Example

/api/dms/objects/903f2ae8-2cfc-476c-8386-55c6811e41da/contents/renditions/pdf

Result Example Response body with PDF document.

GET /api/dms/objects/{objectId}/contents/renditions​/pdf

Microsoft Office and Excel file types

Image File Types

GET /api/dms/objects/{objectId}/contents/renditions/pdf