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
LOCATION,or ANGLE)
l condition – the comparison condition (value of either CONTAINS or NOT_CONTAINS)
The comparison value. Can be one of either of the following, depending upon the
attribute selection:
l bindingStyle – the binding style of the media used (value of either NONE, DEFAULT,
STAPLED, GLUED, STITCHED, ADHESIVE, SPINETAPING, RING, WIREDCOMB, PLASTICCOMB or
COIL)
(only available for attribute = STYLE selections)
l bindingEdge – the binding edge of the media used (value of either DEFAULT, LEFT,
RIGHT, TOP or BOTTOM)
(only available for attribute = SIDE selections)
l bindingType – the binding type of the media used (value of either DEFAULT, SADDLE,
SIDE or CORNER)
(only available for attribute LOCATION selections)
l bindingAngle – the binding angle of the media used (value of either DEFAULT,
VERTICAL, HORIZONTAL or ANGLE)
(only available for attribute = ANGLE selections)
Document Size search – search on document size.
Comprises objects containing the following name/value pairs:
l ruleType – DOCSIZE
l entity – the document size attribute being searched for (value of PAGE, SHEET, or
SECTION)
l condition – the comparison condition (value of either EQ (=), NE (!=), LT (<), GT (>),
LTE (<=) or GTE (>=))
l value – the comparison value (type of number)
Duplex search – search on whether the document contains any duplex sheets.
Comprises objects containing the following name/value pairs:
l ruleType – DUPLEX
l condition – whether the document contains any duplex sheets or not (value of
either "HAS_DUPLEX" or SIMPLEX_ONLY)
Page 134