This Web service is used to execute the APE's two steps in sequence.
Input message format
The JSON input message format is as follows:
{
"merge": {
"jsonDataModel": {},
"locale": "string",
"mimeType": "string",
"namespace": "string",
"options": {},
"templateName": "string"
},
"transform": {
"outputMimeType": "string",
"options": {
"docDescription": {
"author": "string",
"creationDate": "2018-12-03T15:06:22.646Z",
"creator": "string",
"keywords": "string",
"producer": "string",
"subject": "string",
"title": "string"
},
"pdfDocPolicy": {
"allowAccessContent": "string",
"allowAssembleDocument": "string",
"allowCopyContent": "string",
"allowEditAnnotations": "string",
"allowEditContent": "string",
"allowFillInForms": "string",
"allowPrint": "string",
"allowPrintHq": "string",
"encryptMetadata": "string",
"ownerPassword": "string",
"userPassword": "string"
}
}
}
}
When the Web service runs without error, the returned HTTP code is 200 and the response is a document in the requested output format.
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.
Attributes
The message must represent a JSON object with the following attributes:
merge
This attribute is mandatory and Object type. Its value must represent the mergedoc Web service's input message content.
transform
This attribute is mandatory and Object type. Its value must represent the transformxslfo Web service's input message content.
Headers
Some headers can be added in the HTTP request which triggers this web service. These headers are treated as additional input or input-output parameters:
| Name | Type | Description |
|---|---|---|
| Ape-Total-Number-Pages | Input-Output | When the request contains this parameter, it is returned in the response with the total number of pages of the produced document as a value. |