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:

/rest/serverengine/workflow/contentcreation/imagepreview

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:

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

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:

    • 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

    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
    Not Found

    JSON Error specifying error message

    application/zip

    –

    Template or Data Record entity not found in File Store/Server