POST /api/renditions/pdf?level=pdfa3

Owned by Technische Redaktion
Dec 01, 2022
2 min read

This endpoint is offered in a separate API that is available only on request. It is not yet included in yuuvis® Momentum installations.

As of Versionproduct version 2020 Winter | component version 2020 Winter
Request MethodPOST
Response Format

PDF/A-3

Description

To return the PDF/A-3 rendition of the e-mail object, send the request with the e-mail file as binary in the request body.

The endpoint URL contains the specification of the level parameter set to the value to pdfa3. Other values for the level parameter are not accepted.

Synchronously converts all convertible parts of an e-mail including its first order attachments into the format PDF/A-3. The original e-mail itself will be included as a PDF attachment as well.
Requires an e-mail object. A successful POST returns the HTTP status code 200 together with the PDF/A-3 document in the body.

The endpoint accepts the following e-mail attachment file types for the conversion into PDF/A-3 document pages:

TypesExtensionNote
Portable Document Formatpdfdddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd
As of 2021 Autumn: ZIP Archive File Formatzip

The content files of the zip archive will be converted individually and included into the PDF/A-3 file in the order of their sorting in the archive.

The files inside the zip archive have to meet at least one of the following conditions:

  • All files have the same convertible file type.
  • All files are image files of supported types as listed below. Different types are allowed within one zip archive.

The content files of a zip archive will not be converted if at least one zip archive is among them as well.

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 Textodt
OpenDocument Presentationodp
OpenDocument Spreadsheetods
Visio Drawing Filevsd, vsdxlimited 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 Graphicpng
Weppy Image Format (Lossy Compression)webp
As of 2021 Autumn: High Efficiency Image File Format (HEIF)heif, heic

The endpoint provides the following HTTP status codes:

HTTP Status CodeMeaning
200Successful, converted document provided in the response body
413Document file too large
415Document format not supported
422Timeout
422Document could not be converted
422Invalid input parameters
Request Header

Content-Type: message/rfc822 or application/vnd.ms-outlook

Content-Disposition: attachment; filename=<filename>;  filename*=<filename-encoded>.

To set the filename of the new content file. The parameters "filename" and "filename*" differ only in that "filename*" uses the encoding defined in RFC 5987. When both "filename" and "filename*" are present in a single header field value, "filename*" is preferred over "filename".

Request Example

The e-mail file is passed as binary in the request body.

Result Example

HTTP status code:

200

Response body with PDF/A-3 document.