2022.2
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 By Data Set
- Running a Content Creation Operation for Print By Data Record (Using JSON)
- Running a Content Creation Operation for Print By Data (Using JSON)
- Creating a Preview PDF for Print By Data Record
- Creating a Preview PDF for Print By Data
- Creating a Preview PDF for Print By Data (Using JSON)
- Creating a Preview Image By Data Record (Using JSON)
- Creating a Preview Image By Data (Using JSON)
- Running a Content Creation Operation for Email By Data Record (Using JSON)
- Running a Content Creation Operation for Email By Data (Using JSON)
- Creating Content for Web By Data Record
- Creating Content for Web By Data Record (Using JSON)
- Creating Content for Web By Data (Using JSON)
- Running a Job Creation Operation By Content Set (Using JSON)
- Running a Job Creation Operation By Content Set with Runtime Parameters (Usin...
- Running an Output Creation Operation By Job Set
- Running an Output Creation Operation By Job Set (Using JSON)
- Running an Output Creation Operation By Job (Using JSON)
- Running an All-In-One Operation (Using JSON)
- Running an All-In-One Operation with Adhoc Data
- REST API Reference
- All-In-One Service
- Authentication Service
- Content Creation (Email) Service
- Content Creation (HTML) Service
- Content Creation Service
- Service Handshake
- Process Content Creation (By Data Set)
- Process Content Creation (By Data Record) (JSON)
- Process Content Creation (By Data) (JSON)
- Create Preview PDF (By Data Record)
- Create Preview PDF (By Data)
- Create Preview PDF (By Data) (JSON)
- Create Preview Image (By Data Record) (JSON)
- Create Preview Image (By Data) (JSON)
- Get All Operations
- Get Progress of Operation
- Get Result of Operation
- Get Managed Result of Operation
- Cancel an Operation
- Service Version
- Content Item Entity Service
- Content Set Entity Service
- Conversion Service
- Data Mapping Service
- Data Record Entity Service
- Data Set Entity Service
- Document Entity Service
- Document Set Entity Service
- Entity Service
- File Store Service
- Service Handshake
- Download Managed File or Directory
- Download Contents of Managed Directory
- Delete Managed File or Directory
- Get Report
- List Resources
- Managed File or Directory Exists
- Upload Data File
- Upload Data Mapping Configuration
- Upload Template
- Upload Job Creation Preset
- Upload Output Creation Preset
- Service Version
- Job Creation Service
- Job Entity Service
- Job Segment Entity Service
- Job Set Entity Service
- Output Creation Service
- Service Handshake
- Process Output Creation (By Job Set)
- Process Output Creation (By Job Set) (JSON)
- Process Output Creation (By Job) (JSON)
- Run +PReS Enhance Workflow Configuration
- Get All Operations
- Get Progress of Operation
- Get Result of Operation
- Get Result of Operation (as Text)
- Cancel an Operation
- Service Version
- Copyright Information
- Legal Notices and Acknowledgements
l context – the context to be used in the creation of the preview (value of either print,
email or web)
(type of string – Default value is determined by the first context in the template)
l section – the section to be used within the context specified (as either the context
parameter, or else the default context of the template)
(type of string – Default value is determined by the context specified. For the Print
context this will be all enabled sections. For the Email and Web contexts this will be the
default section)
l type – the image type/format to be used in the creation of the preview (value of either jpg,
jpeg or png)
(type of string – Default value of jpg)
l dpi – the target image resolution of the preview in dots per inch (DPI)
(type of number – Default value of 96)
l archive – whether to return the resulting preview as a ZIP file/archive
(type of boolean – Default value is determined automatically by the number of image files
in the preview output)
Specific to parameters with a type parameter specified to a value of png, the following optional
name/value pair can be specified:
l quality – the image quality of the preview (value ranging from 0-100)
(type of number – Default value of 100)
Specific to parameters with a context parameter specified to a value of print, the following
optional name/value pairs can be specified:
l bleed – whether to include the bleed area in the preview
(type of boolean – Default value of false)
l pages – the page range to be output in the preview
(type of string – Default value is determined by the value of the archive parameter. If the
archive parameter is specified to false, then the default value will be 1. If the archive
parameter is either omitted or specified to a value of true, then the default value will be *
(all pages) )
Specific to parameters with a context parameter specified to a value of either email, or web the
following optional name/value pair can be specified:
l viewPortWidth – the image width of the preview in pixels
(type of number – Default value of 1024)
Page 124