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
l type - the type of search rule (value of templatename) (type of string)
l template - the name of the design template used for document (type of string)
l condition - the comparison condition (value of either EQUAL or NOTEQUAL) (type of
string)
Search rule group objects contain the following name/value pairs:
l operator - the search rule operator for sub-list of rules in rule group (value of either
AND or OR) (type of string)
l rules - a sub-list of search rules, consisting of an array of objects each with a
certain rule sub-structure depending on the type of rule
Examples:
{
"entity": "CONTENTITEMS",
"search": {
"operator": "AND",
"rules": [
{
"type": "value",
"value": "FR",
"name": "Country"
},
{
"operator": "OR",
"rules": [
{
"type": "finishing",
"frontcoating": "HIGH_GLOSS",
"backcoating": "HIGH_GLOSS",
"condition": "EQUAL"
},
{
"type": "finishing",
"bindingstyle": "DEFAULT",
"bindingedge": "DEFAULT",
"bindingtype": "DEFAULT",
"bindingangle": "VERTICAL",
"condition": "EQUAL"
}
Page 60