2020.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
- 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 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
In List and Not In List search rules can be configured by specifying the following options:
l Identifiers – List of data entity identifiers to match or not match against
Finishing search rules can be configured by specifying the following options:
l Type – Type of finishing option to compare (e.g. Media Name, Duplex, Coating or
Binding)
Finishing search rules with a Type set to 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)
Finishing search rules with a Type set to Duplex can be further configured by specifying the
following options:
l Duplex – Whether the page sheet is duplex or not
Finishing search rules with a Type set to Coating can be further configured by specifying the
following options:
Page 175