1.8
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
- Service Handshake
- Process Content Creation
- Process Content Creation (By Data Record) (JSON)
- Process Content Creation (By Data) (JSON)
- Create Preview PDF
- Create Preview PDF (By Data Record)
- Create Preview PDF (By Data) (JSON)
- Get All Operations
- Get Progress of Operation
- Get Result of Operation
- Cancel an Operation
- Service Version
- 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 Acknowledgements
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.)
Finishing search rules with a Type set to Binding can be further configured by specifying the
following options:
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 Length 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 Name 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 Groups can be configured by specifying the following options:
l Rules Operator – Operator for the matching of search rules contained in the group (e.g.
Match All Rules (AND) or Match Any Rules (OR))
Rule Groups can be removed using the Remove Rule Group button, and in situations where
removing a rule group would remove multiple rules, you will be prompted to confirm the
removal of the rule group.
Page 176