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:

  • Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded)
  • auth_token – Authorization Token

Parameters

Path Parameters

The following lists the path 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

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:

  • a type value of JPG or JPEG

  • an archive value and pages value that would result in a single page

200
OK

Preview Image

image/png

–

Creation of a preview image successful.

Response when the image parameters specified contain:

  • a type value of PNG

  • an archive value and pages value that would result in a single page

200
OK

Preview Images (Zipped)

 application/zip

–

Creation of preview images successful.

Response when the image parameters specified contain:

  • an archive value and pages value that would result in a multiple pages

Error

The following lists status codes indicative of a failed or error response:

Status Code Content Content-Type Add. Headers Description

400
Bad Request

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:

  • basic authentication credentials nor an authorization token have been specified in the request headers

  • the basic authentication credentials or the authorization token specified in the request headers are invalid

  • the authorization token specified in the request headers has now expired

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 not found in File Store