Create Preview Image (By Data) (JSON)
Submits a request to create a preview image of the print, email, or web output for a single data record.
Request takes a JSON Record Data List (with Image Parameters) of the data values for the Data Record as content, and on success returns a response containing the image output produced, specific to the record data and parameters specified.
Request
Method Type: |
POST |
---|---|
URI: |
/rest/serverengine/workflow/contentcreation/imagepreview/{templateId} |
Content: | JSON Record Data List (with Image Parameters) of the data values for the Data Record |
Content Type: |
application/json |
Add. Headers: |
If server security settings are enabled, then one of the following:
|
Parameters
Path Parameters
The following lists the path parameters accepted by this method:
Name | Required | Type | Default Value | Description |
---|---|---|---|---|
templateId |
Yes |
String |
– |
|
Response
Success
The following lists status codes indicative of a successful response:
Status Code | Content | Content-Type | Add. Headers | Description |
---|---|---|---|---|
200 OK |
Preview Image |
image/jpeg |
– |
Creation of a preview image successful. Response when the image parameters specified contain:
|
200 OK |
Preview Image |
image/png |
– |
Creation of a preview image successful. Response when the image parameters specified contain:
|
200 OK |
Preview Images (Zipped) |
application/zip |
– |
Creation of preview images successful. Response when the image parameters specified contain:
|
Error
The following lists status codes indicative of a failed or error response:
Status Code | Content | Content-Type | Add. Headers | Description |
---|---|---|---|---|
401 Unauthorized |
– |
– |
WWW-Authenticate – BASIC (Basic Authentication credentials are accepted) |
Server authentication is required. Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. |
401 Unauthorized |
Error message |
– |
– |
Server authentication has failed. Response when the authorization token specified in the request headers has now expired. |
403 Forbidden |
Error message |
– |
– |
Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid. |
404 |
JSON Error specifying error message |
application/zip |
– |
Template found in File Store |