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 Name - Name of the data entity property to group the search results by
l Order - Group the search results for this data entity property in a specific order (e.g.
Ascending or Descending)
Note
By default, comparison conditions in search rules are evaluated alphanumerically,
regardless of the type of value.
Numeric evaluation of comparison conditions is not currently supported in the
PlanetPress Connect RESTAPI.
The only exception to this rule is the ability to numerically sort or group results by
specifying sorting or grouping rules of a Data Value type.
Warning
The Entity Type selected for the search criteria can be changed during or even after
rules have been added. But because certain rules are only available for certain data
entity types, some of the existing rules in the search criteria may become incompatible.
In situations where incompatible rules are found in the existing search criteria, you will be
prompted to confirm the change of entity type. If you then proceed with the change of
entity type, any incompatible rules found in the existing search criteria will be removed.
Once the search criteria is constructed, and the required inputs populated, simply select the
Submit button. This will submit the request to the server and display the search criteria
specified as input to the Results area in JSON Search Parameters format.
The result will then be returned as a list of Data Entity IDs which will be appended to the
Results area in both Plain table and JSON Identifier Lists (with Sort Key) formats.
To construct a new search criteria, the Reset button can be selected. This will reset the form,
removing all existing rules.
Further Reading
See the Entity Service page of the REST API Reference section for further detail.
Page 143