1.7
Table Of Contents
- Table of Contents
- Welcome to the PlanetPress Connect REST API Cookbook
- Technical Overview
- Working Examples
- Getting Started
- Server Security & Authentication
- Working with the File Store
- Working with the Entity Services
- Working with the Workflow Services
- Running a Data Mapping Operation
- Running a Data Mapping Operation (Using JSON)
- Running a Data Mapping Operation for PDF/VT File (to Data Set)
- Running a Data Mapping Operation for PDF/VT File (to Content Set)
- Running a Content Creation Operation for Print
- Running a Content Creation Operation for Print By Data Record (Using JSON)
- Running a Content Creation Operation for Email By Data Record (Using JSON)
- Creating Content for Web By Data Record
- Creating Content for Web By Data Record (Using JSON)
- Running a Job Creation Operation (Using JSON)
- Running an Output Creation Operation
- Running an Output Creation Operation (Using JSON)
- Running an Output Creation Operation By Job (Using JSON)
- Running an All-In-One Operation (Using JSON)
- REST API Reference
- Authentication Service
- Content Creation Service
- Content Item Entity Service
- Content Set Entity Service
- Data Record Entity Service
- Data Set Entity Service
- Data Mapping Service
- Document Entity Service
- Document Set Entity Service
- Content Creation (Email) Service
- Entity Service
- File Store Service
- Content Creation (HTML) Service
- Job Creation Service
- Job Entity Service
- Job Segment Entity Service
- Job Set Entity Service
- Output Creation Service
- All-In-One Service
- Copyright Information
- Legal Notices and Acknowledgments
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.
Type: GET
URI:
/rest/serverengine/workflow/contentcreation/pdfpreviewdirect
Parameters:
Query:
l templateId – the Managed File ID (or Name) of the design template in
File Store
l dataRecordId – the ID of the Data Record entity in Server
Request:
Add.
Headers:
auth_token – Authorization Token (if server security
settings enabled)
Content: -
Content
Type:
-
Response:
Add.
Headers:
-
Content: Managed File ID
Content
Type:
text/plain
Status:
l 200 OK – Creation of preview PDF in File Store
successful
Page 297