1.7
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
- 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 Acknowledgments
Search rule objects with a type value of value contain the following name/value pairs:
l type - the type of search rule (value of value) (type of string)
l name - the name of the data field (type of string)
l value - the value of the data field (type of string, or array of strings when
condition is value of either IN or NOT IN)
l condition - the comparison condition (value of either EQUAL, NOTEQUAL, LESS, GREAT,
LESSEQUAL, GREATEQUAL, STARTSWITH, ENDSWITH, CONTAINS, LIKE, NLIKE, IN or NOT IN)
(type of string)
Search rule objects with a type value of property contain the following name/value pairs:
l type - the type of search rule (value of property) (type of string)
l name - the name of the data entity property (type of string)
l value - the value of the data entity property (type of string, or array of strings
when condition is value of eitherIN or NOT IN)
l condition - the comparison condition (value of either EQUAL, NOTEQUAL, LESS, GREAT,
LESSEQUAL, GREATEQUAL, STARTSWITH, ENDSWITH, CONTAINS, LIKE, NLIKE, IN or NOT IN)
(type of string)
Search rule objects with a type value of either IN or NOT IN contain the following
name/value pairs:
l type - the type of search rule (value of either IN or NOT IN) (type of string)
l identifiers - an array of data entity identifiers (type of number)
Search rule objects with a type value of finishing contain only one of the following sub-
groups of name/value pairs:
l type - the type of search rule (value of finishing) (type of string)
l medianame - the name of the media used (type of string)
l condition - the comparison condition (value of either EQUAL or NOTEQUAL) (type of
string)
l type - the type of search rule (value of finishing) (type of string)
l duplex - whether the page sheet is duplex (type of boolean)
Page 58