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
o
subject – the subject of the email message (type of string)
o
to – the email addresses of the recipients in the email message (type of string)
o
body – the name of the HTML email body file in the email message output (type of
string)
o
folder – the managed file ID for the output directory in the file store containing the
email message output (type of number)
o
attachments – a list of the file attachments to the email message, consisting of an
array of objects each with the following name/value pairs:
l name – the name of the file attachment in the email message output (type of
string)
l disposition – the disposition of the attachment to the email message (type of
string)
Specific to inclusion of meta tags in the template's scripts, the following optional
name/value pairs can be specified:
o
from – the email address of the sender in the email message (type of string)
o
cc – the email addresses of the carbon copy (CC) recipients in the email message
(type of string)
o
bcc – the email addresses of the blind carbon copy (BCC) recipients in the email
message (type of string)
o
replyTo – the email addresses to reply to in the email message (type of string)
o
headers – a list any custom email headers in the email message, consisting of an
array of objects each with the following name/value pairs:
l <name> – the name (name) and value of the email header (type of string)
Specific to email message output where an EML (E-Mail Message) file is to be created,
the following name/value pair will be specified:
o
eml – the name of the EML (E-Mail Message) file in the email message output (type
of string)
Specific to templates with an email context section configured to append a plain-text copy
of the HTML, the following name/value pair will be specified:
o
text – the name of the TXT email file in the email message output (type of string)
Page 57