2019.2
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
object with one or more name/value pairs:
l <name> – the name (name) of the data table and the data table schema for the
data record entities it contains, consisting of an object with the following
name/value pair:
l columns – a list of the data columns/fields in the data table schema and
their corresponding data types, consisting of an object with one or more
name/value pairs:
l <name> – the name (name) and data type of the data field (value of
either BOOLEAN, STRING, HTMLSTRING, INTEGER, FLOAT, DATETIME or
CURRENCY) (type of string)
l fields – a list of the data fields in the data record entity and their corresponding data
values, consisting of an object with one or more name/value pairs:
l <name> – the name (name) and data value of the data field (type of either string,
number, or boolean)
l tables – a list of any nested data tables in the data record entity, consisting of an object
with one or more name/value pairs:
l <name> – the name (name) of the data table and a list the data record entities it
contains, consisting of an array of objects each with the following name/value
pairs:
l id – the data record entity identifier (type of number)
l fields – a list of the data fields in the data record entity and their
corresponding data values, consisting of an object with one or more
name/value pairs:
l <name> – the name (name) and data value of the data field (type of either
string, number, or boolean)
Specific to data record entities that are children of a data set entity (data record entities in the
root or master data table), an additional name/value pair is included:
l datasetid – the data set entity identifier of parent entity (type of number)
If a data record entity contains boundary information (set from the data source during data
mapping), then an additional name/value pair is also included:
l boundaries – the boundaries for the data record, consisting of an object with the
following name/value pairs:
Page 49