This Web service is used to execute the APE's merge step.

Input message format

The JSON input message format is as follows:

{

"jsonDataModel": {},

"locale": "string",

"mimeType": "string",

"namespace": "string",

"options": {},

"templateName": "string"

}

When the Web service runs without error, the returned HTTP code is 200 and the response is an XML document (when an .ftlx template is processed).

If there is an error, the returned HTTP code is either 400 if the query body is incorrect, or 500 when an error occurs during template processing. If there is an error, the returned response is JSON type.

↑ Top of page

Attributes

The message must represent a JSON object with the following attributes:

templateName

This attribute is mandatory and String type. It represents the template name (file name.ftlx). See "Template" section in "Apache FreeMarker Template Engine".

namespace

This attribute is optional and String type. It represents the namespace used by the engine to look up the template. See "Template loader" section in "Apache FreeMarker Template Engine".

jsonDataModel

This attribute is mandatory and Object type. It represents the data model which will be used by the engine to process the template. See "Data model" section in "Apache FreeMarker Template Engine".
Table of correspondences between FreeMarker data types and JSON data types:

locale

This attribute is optional and String type. It represents the locale used by the engine to look up and process the template. See "Locale" section in "Apache FreeMarker Template Engine". If this attribute is not specified, the JVM default locale is used. The alphanumeric string representing the locale must be in IETF BCP 47 format.

mimeType

This attribute is optional and String type. It represents the MIME type of the Web service response.

FreeMarker is configured to automatically return a MIME type according to the file extension of the executed template:

• .ftlx: application/xml (charset=UTF-8) type response
• .ftlh (HTML document template): text/html (charset=UTF-8) type response
• .ftlx (XML document template): application/xml (charset=UTF-8) type response

A value does not, therefore, need to be set for this attribute when executing .ftlx templates.

When using this Web service outside the APE (to merge data with a CSV template for example), a value needs to be set to this attribute ("text/csv" for example).

↑ Top of page

options

This attribute is optional and Object type.

It represents the additional parameters to take into account when processing the template.

• extOutputTransform
  Result document formatting option (JSON String type)

   

• jsonPathConv
  Option to convert data from the data model before it is processed by the template (JSON Object array type)

   

• jsonGenerator
  Option to produce a fake data model used in place of the data model in the template development phase (JSON Object type).

↑ Top of page