Convert Document

Back to overview

Endpoint

POST https://api.reporting.cloud/v1/document/convert

Converts a document to another format

Quota

This method counts against the document quota.

Request Parameters

Query parameter Value Type Value
returnFormat String A string that specifies the format of the created document. Possible values are: PDF, RTF, DOC, DOCX, HTML and TX.
test Boolean Optional. Specifies whether it is a test run or not. A test run is not counted against the quota and created documents contain a watermark.
Request body data Value type Value
Base64 encoded string The source document encoded as a Base64 string. Possible document formats are .rtf, .doc, .docx, .html, .pdf and .tx.

Response Format

On success, the HTTP status code in the response header is OK (200). The response body contains the converted document encoded as a Base64 encoded string.

A Forbidden (403) is returned, if the user is not authorized or the document quota is exceeded.

A Bad Request (400) is returned, if no data is found in the request body.

Examples

Note: The code examples available for this method do not represent all supported programming languages.

Try this in the Web API Sandbox

Open Sandbox