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
l name – the name of the data field (type of string)
l value – the value of the data field (type of string)
Specific to data record entities that are children of a data set entity (data record entities in the
root or master data table), two additional name/value pairs are included:
l table – the data record entity data table name (value of record) (type of string)
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:
l start – the starting boundary value for the data record (type of number)
l end – the ending boundary value for the data record (type of number)
Specific to nested data record entities that are children of a data record entity, two additional
name/value pairs are included:
l table – the data record entity data table name (type of string)
l parentrecordid – the data record entity identifier of parent entity (type of number)
Example
The following are examples of this structure:
{
"id": 12345,
"table": "record",
"datasetid": 34567,
"fields": [
{
"name": "ID",
"value": "CU00048376"
},
{
"name": "Gender",
"value": "M."
Page 40