Template Info

Back to overview

Endpoint

GET https://api.reporting.cloud/v1/templates/info

Returns information about the template including merge fields and merge blocks

Request Parameters

Query parameter Value Type Value
templateName String The filename of the template in the template storage.

Response Format

On success, the HTTP status code in the response header is OK (200). The response body contains a ReportingCloud TemplateInfo object.

A Forbidden (403) is returned, if the user is not authorized.

A Bad Request (400) is returned, if the template doesn't exist in the template storage..

TemplateInfo object

Key Value type Value description
templateName String The filename of the template in the template storage.
mergeBlocks List of ReportingCloud MergeBlock objects Contains all merge blocks in the template.
mergeFields List of ReportingCloud MergeField objects Contains all merge fields in the template.

MergeBlock object

Key Value type Value description
name String The name of the MergeBlock.
mergeBlocks List of ReportingCloud MergeBlock objects Contains all merge blocks in the template.
mergeFields List of ReportingCloud MergeField objects Contains all merge fields in the template.

MergeField object

Key Value type Value description
dateTimeFormat String Specifies a string format which is applied to date / time values.
name String Gets and sets the name of the field.
numericFormat String Specifies a string format which is applied to numeric values.
preserveFormatting Boolean Specifies whether the formatting is preserved.
text String Gets and sets the text of the field.
textAfter String Gets and sets the text after the field.
textBefore String Gets and sets the text before the field.

Examples

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

Coming soon...
Coming soon...
Coming soon...

Try this in the Web API Sandbox

Open Sandbox