Templates
The template storage holds the templates your account keeps in ReportingCloud, so that a merge request only has to name one, and the endpoints below /v1/templates manage it. They upload a template in DOC, DOCX, RTF or TX format, list, count, download and delete the stored templates and check whether a template exists. For a single template, they return its merge fields and merge blocks (info), its number of pages (pagecount) and images of its pages (thumbnails). A method that works on one template takes its file name in the templateName parameter, and uploads and downloads carry the template as a Base64 string.
An upload under a new name counts against the template storage quota. An upload under the name of a stored template replaces that template and doesn't count again. Deleting a template lowers the count again. Template names are not case-sensitive: Invoice.docx and invoice.DOCX name the same template. Template thumbnails count against the document quota. Every SDK has a method for each endpoint; in .NET they are UploadTemplate, ListTemplates, GetTemplateCount, TemplateExists, DownloadTemplate, DeleteTemplate, GetTemplateInfo, GetTemplatePageCount and GetTemplateThumbnails. The guide page Managing Templates shows them in use, and the portal's Template Storage manages the same templates in the browser.
Methods
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/templates/count | Returns the number of templates in the template storage. |
DELETE | /v1/templates/delete | Deletes a template from the ReportingCloud template storage. |
GET | /v1/templates/download | Returns the selected template from the storage. |
GET | /v1/templates/exists | Checks whether a template exists in the template storage. |
GET | /v1/templates/info | Returns information about the template including hierarchical structure of merge fields and merge blocks. |
GET | /v1/templates/list | Lists all templates from the ReportingCloud template storage. |
GET | /v1/templates/pagecount | Returns the number of pages of a template in the template storage. |
GET | /v1/templates/thumbnails | Creates and returns thumbnail images of template pages. |
POST | /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). |