2019.2
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
JSON Identifier List (with Email Parameters)
Describes a list of identifiers for multiple data entities (specifically data record entities), along
with additional parameters used specifically in an content creation operation for email.
Structure
The structure consists of an object with the following name/value pairs:
l identifiers – an array of data record entity identifiers (type of number)
l host – the network address or name of the SMTP mail server through which emails will
be sent. If required, a server port value can also be specified (type of string)
l user – the user name to authenticate with (if using authentication) (type of string)
l password – the password to authenticate with (if using authentication) (type of string)
l sender – the email address to be shown as the sender in the email output (type of string)
l useAuth – parameter to specify if authentication is to be used with the mail server (type of
boolean)
l useStartTLS – parameter to specify if Transport Layer Security (TLS) is to be used when
sending emails (type of boolean)
l useSender – parameter to specify if the sender address will be used as the receiver
address for all emails in the output (type of boolean)
l attachWebPage – parameter to specify if a single HTML web page (with embedded
resources) of the Web context should also be created and attached to the email output
(type of boolean)
l attachPdfPage – parameter to specify if a PDF of the Print context should also be created
and attached to the email output (type of boolean)
Example
The following is an example of this structure:
{
"identifiers": [
12345,
23456
],
"host": "mail.company.com:587",
"user": "johns",
"password": "password5",
Page 73