Create Preview Image (By Data Record) (JSON)
Submits a request to create a preview image of the print, email, or web
Request takes a set of JSON Image Parameters 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: | |
Content: | JSON Image Parameters specifying parameters to be used for content creation |
Content Type: |
application/json |
Add. Headers: |
If server security settings are enabled, then one of the following:
|
Parameters
Query Parameters
The following lists the query parameters accepted by this method:
Name | Required | Type | Default Value | Description |
---|---|---|---|---|
templateId |
Yes |
String |
– |
The Managed File ID (or Name) of the template in File Store |
dataRecordId |
Yes |
Number |
– |
The ID of the Data Record entity in Server |
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 |
---|---|---|---|---|
400 |
JSON Error specifying error message |
application/json |
– |
Context not found / Section not found |
401 Unauthorized |
JSON Error specifying error message |
application/json |
WWW-Authenticate – BASIC (Basic Authentication credentials are accepted) |
Server authentication has failed. Response when either:
|
403 Forbidden |
JSON Error specifying error message |
application/json |
– |
Server authentication has succeeded, but user authorization for this specific method has failed. Response when authentication of the credentials or the authorization token specified in the request headers has succeeded, but the user associated with the credentials or the authorization token specified has insufficient role assignment/privileges. |
404 Not Found |
JSON Error specifying error message |
application/json |
– |
Template or Data Record entity not found in File Store/Server |