2021.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 By Data Set
- Running a Content Creation Operation for Print By Data Record (Using JSON)
- Running a Content Creation Operation for Print By Data (Using JSON)
- Creating a Preview PDF for Print By Data Record
- Creating a Preview PDF for Print By Data
- Creating a Preview PDF for Print By Data (Using JSON)
- Creating a Preview Image By Data Record (Using JSON)
- Creating a Preview Image By Data (Using JSON)
- Running a Content Creation Operation for Email By Data Record (Using JSON)
- Running a Content Creation Operation for Email By Data (Using JSON)
- Creating Content for Web By Data Record
- Creating Content for Web By Data Record (Using JSON)
- Creating Content for Web By Data (Using JSON)
- Running a Job Creation Operation By Content Set (Using JSON)
- Running a Job Creation Operation By Content Set with Runtime Parameters (Usin...
- Running an Output Creation Operation By Job Set
- Running an Output Creation Operation By Job Set (Using JSON)
- Running an Output Creation Operation By Job (Using JSON)
- Running an All-In-One Operation (Using JSON)
- Running an All-In-One Operation with Adhoc Data
- REST API Reference
- All-In-One Service
- Authentication Service
- Content Creation (Email) Service
- Content Creation (HTML) Service
- Content Creation Service
- Service Handshake
- Process Content Creation (By Data Set)
- Process Content Creation (By Data Record) (JSON)
- Process Content Creation (By Data) (JSON)
- Create Preview PDF (By Data Record)
- Create Preview PDF (By Data)
- Create Preview PDF (By Data) (JSON)
- Create Preview Image (By Data Record) (JSON)
- Create Preview Image (By Data) (JSON)
- Get All Operations
- Get Progress of Operation
- Get Result of Operation
- Get Managed Result of Operation
- Cancel an Operation
- Service Version
- Content Item Entity Service
- Content Set Entity Service
- Conversion Service
- Data Mapping Service
- Data Record Entity Service
- Data Set Entity Service
- Document Entity Service
- Document Set Entity Service
- Entity Service
- File Store Service
- Job Creation Service
- Job Entity Service
- Job Segment Entity Service
- Job Set Entity Service
- Output Creation Service
- Service Handshake
- Process Output Creation (By Job Set)
- Process Output Creation (By Job Set) (JSON)
- Process Output Creation (By Job) (JSON)
- Run +PReS Enhance Workflow Configuration
- Get All Operations
- Get Progress of Operation
- Get Result of Operation
- Get Result of Operation (as Text)
- Cancel an Operation
- Service Version
- Copyright Information
- Legal Notices and Acknowledgements
JSON Record Data List
Describes a list of data fields (as name/value pairs), a data table schema and nested data
records (if any) for one or more data records.
This structure is used specifically by the Content Creation and Content Creation (HTML)
services when creating content directly without the prerequisite of the data mapping process.
Structure
The structure consists of an object with the following name/value pair:
l data – the data for the data record or data records, consisting of either an object or an
array of one or more objects respectively with the following name/value pairs:
l schema – the data table schema for the data record, consisting of an object with the
following name/value pairs:
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 tables – a list of any nested data tables in the data record, consisting of an
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 records 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 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)
Page 114