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 id - the data record entity identifier (type of number)
l fields - a list of data fields in the data record entity, consisting of an array of objects
each with the following name/value pairs:
l name - the name of the data field (type of string)
l value - the value of the data field (type of string)
l records - a list of any nested data record entities, consisting of an array of objects each
with the following name/value pairs:
l id - the data record entity identifier (type of number)
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)
l fields - a list of data fields in the data record entity, consisting of an array of
objects each with the following name/value pairs:
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
record 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)
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)
Examples:
{
"id": 12345,
"table": "record",
"datasetid": 34567,
"fields":[
{
"name": "ID",
"value": "CU00048376"
Page 32