Create Preview PDF (By Data Record)

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

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

Request

Method Type:

GET

URI:

/rest/serverengine/workflow/contentcreation/pdfpreviewdirect

Content:
Content Type:

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

Query

Name Required Type Default Value Description
templateId

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

dataRecordId

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

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 or Data Record entity not found in File Store/Server