2019.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
Lastly, select the Rules Operator for the matching of search rules contained in the base rules
list (e.g. Match All Rules (AND) or Match Any Rules (OR))
Sorting Rules
There are also two types of sorting rules that can be used as part of the overall search criteria:
l Data Value – Sort the search results by the value of a data record field
l Property Value – Sort the search results by the value of a data entity property
The types of sorting rules available are also specific to the data entity type selected. The
following table lists the available combinations:
Rule Type Data
Records
Data
Sets
Content
Items
Content
Sets
Jobs Job
Sets
Data Value
✓ ✓
Property Value
✓ ✓ ✓ ✓ ✓ ✓
Sorting rules can be added using the Add Sorting Rule button, removed using the Remove
Rule button, and even re-ordered within the form.
Rules can be re-ordered by dragging and dropping a rule by it's name label (e.g. Data Value
Rule: or Property Value Rule:).
Data Value sorting rules can be configured by specifying the following options:
l Name – Name of the data record field to sort the search results by
l Numeric – Sort the search results for this data record field numerically
l Order – Sort the search results for this data record field in a specific order (e.g. Ascending
or Descending)
Property Value sorting rules can be configured by specifying the following options:
Page 177