2022.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 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
- Service Handshake
- Download Managed File or Directory
- Download Contents of Managed Directory
- Delete Managed File or Directory
- Get Report
- List Resources
- Managed File or Directory Exists
- Upload Data File
- Upload Data Mapping Configuration
- Upload Template
- Upload Job Creation Preset
- Upload Output Creation Preset
- Service Version
- 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
JSON All-In-One Configuration
Describes the configuration of an All-In-One operation as a series of name/value pairs
representing the processes (data mapping, content creation, job creation and output creation) to
be completed as part of the overall operation. The value in each pair contains the parameters
for that specific process.
The structure is variable, allowing for configurations containing one or more specific processes
(as name/value pairs), as long as the processes specified result in a logical sequence or
workflow. Used specifically with the All-In-One service.
Structure
The structure consists of an object with the following name/value pairs:
l datamining – data mapping configuration parameters, consisting of an object with the
following name/value pairs:
l identifier – the managed file identifier (type of number) or named identifier (type of
string) of the data file
l config – the managed file identifier (type of number) or named identifier (type of
string) of the data mapping configuration
l parameters (optional) – a set of runtime parameter names and their corresponding
values, consisting of an object with one or more name/value pairs:
l <name> – the name (name) and the value of the runtime parameter
(type of either string, number, or boolean)
l contentcreation – content creation configuration parameters, consisting of an object
with the following name/value pairs:
l identifiers – an array of data record entity identifiers (type of number) (optional for
configurations containing data mapping parameters)
l config – the managed file identifier (type of number) or named identifier (type of
string) of the input template
l parameters (optional) – a set of runtime parameter names and their corresponding
values, consisting of an object with one or more name/value pairs:
l <name> – the name (name) and the value of the runtime parameter
(type of either string, number, or boolean)
Page 45