}

/v1/document/convert

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

Converts a document to another supported format.

Document Quota

This method counts against the document quota. For each successful request, the quota count is increased by 1.

Authorization

This endpoint requires a "ReportingCloud-APIKey" or a "Basic" user authorization to access the user acount, data and templates. Only one of these two methods are required.

ReportingCloud-APIKey
Header field Description
Authorization

Required. A valid ReportingCloud account is required. The Authorization field is constructed as follows:

An API Key needs to be generated using the portal or /v1/account/apikey endpoint. The authorization method and a space i.e. "ReportingCloud-APIKey " is then put before the actual API Key string.

Sample:

Authorization: ReportingCloud-APIKey oMDM4MrAqL9QEOpyzupnQW5NjvCNtvE5cVDaaLqxI

Basic
Header field Description
Authorization

Required. A valid ReportingCloud account is required. The Authorization field is constructed as follows:

The username and password are combined into a string separated by a colon, e.g.: username:password. The resulting string is encoded using the RFC2045-MIME variant of Base64, except not limited to 76 char/line. The authorization method and a space i.e. "Basic " is then put before the encoded string.

Sample:

Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l


Request Parameters

Query Parameter Value Type Description
returnFormat String A string that specifies the format of the created document. Possible values are: PDF, PDFA, RTF, DOC, DOCX, HTML and TX.
test Boolean Specifies whether it is a test run or not. A test run is not counted against the quota and created documents contain a watermark. Not possible using the Free or Trial license.

Request Payload

Value Type Description
Base64 encoded string The source document encoded as a Base64 string. Possible document formats are .rtf, .doc, .docx, .html, .pdf and .tx.

AppendBody

Key Value Type Description
documents ReportingCloud AppendDocument object The documents that are appended including divider options.
documentSettings ReportingCloud DocumentSettings object Optional. Document settings to specify document properties such as title and author.

AppendDocument

Key Value Type Description
document String The document as a Base64 encoded string.
documentDivider Integer The document divider option. Possible values: 1 (None), 2 (NewParagraph), 3 (NewSection).

DocumentSettings

Key Value Type Description
author String Optional. Sets the document's author.
creationDate DateTime (String) Optional. Sets the document's creation date which will be saved in the document.
lastModificationDate DateTime (String) Optional. Sets the date the document is last modified.
creatorApplication String Optional. Optional. Sets the application, which has created the document.
documentSubject DateTime (String) Optional. Optional. Sets the document's subject string which will be saved in the document.
documentTitle DateTime (String) Optional. Optional. Sets the document's title that will be saved in the document.
userPassword DateTime (String) Optional. Optional. Specifies the password for the user to open the document.

Success Response

Return Value Descripton

200 (OK)

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

Error Response

Return Value Descripton

403 (Forbidden)

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

400 (Bad Request)

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

Sample Requests

Request:

Results:

Request:

Results:

Request:

Results:

Request:

Results:

Request:

Results: