2021.1
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
- 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
Data Value search rules can be configured by specifying the following options:
l Name – Name of the data record field to search by
l Condition – Operator for the comparison of the data record field (e.g. Equals (=), Not
Equals (<>), Less Than (<), Greater Than (>), etc.)
l Value – Value of the data record field to match
Property Value search rules can be configured by specifying the following options:
l Name – Name of the data entity property to search by
l Condition – Operator for the comparison of the data entity property (e.g. Equals (=), Not
Equals (<>), Less Than (<), Greater Than (>), etc.)
l Value – Value of the data entity property to match
Value In and IDIn search rules can be configured by specifying the following options:
l Identifiers – List of data entity identifiers to match or not match against
Document Media search rules for Media Name can be further configured by specifying the
following options:
l Condition – Operator for the comparison of the media name (e.g. Equals (=) or Not
Equals (<>))
l Value – Value of the media name to match (e.g. Plain Letter Paper)
Document Media search rules for Coating can be further configured by specifying the following
options:
l Condition – Operator for the comparison of the coating (e.g. Equals (=) or Not Equals
(<>))
l Front Coating – The type of front coating to match (e.g. Semi Gloss, Satin, Matte, Glossy,
None, etc.)
l Back Coating – The type of back coating to match (e.g. Semi Gloss, Satin, Matte, Glossy,
None, etc.)
Document Binding search rules can be further configured by specifying the following options:
Page 215