2018.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
- 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 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 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 design template
l jobcreation – job creation configuration parameters, consisting of an object with the
following name/value pairs:
l config – the managed file identifier (type of number) or named identifier (type of
string) of the job creation preset (optional)
l outputcreation – output creation configuration parameters, consisting of an object with
the following name/value pairs:
l identifiers – an array of job entity identifiers (type of number) (optional for
configurations containing content creation parameters)
l config – the managed file identifier (type of number) or named identifier (type of
Page 82