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
l errors – a list of any errors that occurred during content creation, consisting of an array of
objects each with the following name/value pairs:
o
record –the data record index associated with the error (type of number)
o
message –the description of the error that occurred (type of string)
l contentSet – the content set entity identifier for the email output (type of number)
Examples
The following is an example of this structure:
{
"messages": [
{
"attachments": [
{
"name": "att97529c81-f882-4c21-8b39-
a404f728d43e.png",
"disposition": "inline"
},
{
"name": "att2fa0f059-ec10-4054-b859-
36ad1f2fdf59.png",
"disposition": "inline"
},
{
"name": "att86c7b3c2-3483-4926-b893-
608a42231d70.jpg",
"disposition": "inline"
},
{
"name": "attf086d7d3-d33f-478a-b1a6-
771deeb39b5b.png",
"disposition": "inline"
},
{
"name": "attb0db370d-db4d-4bc3-93be-
82438603c253.png",
"disposition": "inline"
},
{
Page 58