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
l Binding Style – The style of binding to match (e.g. Stapled, Glued, Stitched, Coil, etc.)
l Binding Edge – The edge (or side on which the binding occurs) to match (e.g. Left, Right,
Top or Bottom)
l Binding Type – The type or location of the binding to match (e.g. Saddle, Side or Corner)
l Binding Angle – The binding angle to match (e.g. Vertical, Horizontal or Angle)
Document Size search rules can be configured by specifying the following options:
l Condition – Operator for the comparison of the document length (e.g. Equals (=), Not
Equals (<>), Less Than (<), Greater Than (>), etc.)
l Value – Value of the document length to match
Template search rules can be configured by specifying the following options:
l Condition – Operator for the comparison of the template name (e.g. Equals (=) or Not
Equals (<>))
l Value – Value of the template name to match (e.g. letter-ol)
Rule Set can be configured by specifying the following conditions:
l Rules Conditions – Conditions for the matching of search rules contained in the rule set.
The options are Match All Rules (ALL); Match Any Rule (ANY); Not Match All Rules
(NOTALL); Not Match Any Rule (NOTANY)
Individual rules can be added to a Rule Set by selecting the appropriate Rule Type Selector
option and then clicking the Add Search Rule button within the Rule Set box.
Individual rules can be removed by clicking the associated Remove Rule button within the
Rule Set box.
Rule Sets can be removed using the Remove Set button, and in situations where removing a
rule set would remove multiple rules, you will be prompted to confirm the removal of the rule
set.
Lastly, select the Rules Operator for the matching of search rules contained in the base rules
list (e.g. Match All Rules (AND) or Match Any Rules (OR))
Page 216