Create Preview PDF (By Data)

Submits a request to create a preview PDF of the print output for a single data record.

Request takes binary file data as content, and on success returns a response containing the Managed File ID for the newly created preview PDF file.

Request

Method Type:

POST

URI:

/rest/serverengine/workflow/contentcreation/pdfpreview/{templateId}/{dmConfigId}

Content: Data File (File)
Content Type:

application/octet-stream

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

Name Required Type Default Value Description
templateId

–

–

–
  • The Managed File ID (or Name) of the template in File Store
    		•

    dmConfigId

    –

    –

    –

    The Managed File ID (or Name) of the Data Mapping configuration in File Store

    Query

    Name Required Type Default Value Description
    persist

    –

    –

    true

    Whether the Data Record produced will be persisted in Server

    Response

    Success

    The following lists status codes indicative of a successful response:

    Status Code Content Content-Type Add. Headers Description
    200
    OK    		 Managed File ID text/plain – Creation of preview PDF in File Store successful

    Error

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

    Status Code Content Content-Type Add. Headers Description

    400
    Bad Request

    –

    –

    –

    Unable to open resource within template or resource doesn’t exist

    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

    –

    –

    –

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