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:
|
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 |
---|---|---|---|---|
400 |
JSON Error specifying error message |
application/json |
– |
Unable to open resource within template or resource doesn’t exist / 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 |