}

/v1/templates/upload

https://api.reporting.cloud/v1/templates/upload

Stores an uploaded template in the ReportingCloud template storage. Supported template formats are Microsoft Word (.doc), WordProcessingML (.docx), Rich Text Format (.rtf) and TX Text Control Format (.tx).

Template Storage Quota

This method counts against the template storage quota. For each uploaded template, the quota count is increased by 1. Deleting templates decreases the template storage quota.

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
templateName String The filename of the template in the template storage. Existing files with the same filename will be overwritten.

Request Payload

Value Type Description
Base64 encoded string A document encoded as a Base64 string. Supported document formats are .doc, .docx, .rtf and .tx.

Success Response

Return Value Descripton

201 (Created)

On success, the HTTP status code in the response header is 201 (Created). The response body contains an array of the created documents encoded as Base64 encoded strings.

Error Response

Return Value Descripton

403 (Forbidden)

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

400 (Bad Request)

A 400 (Bad Request) is returned, if the template has a wrong format or is corrupted.

Sample Requests

Request:

Request:

Results:

Request:

Request:

Request:

Results: