2019.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
Process All-In-One (Adhoc Data)
Submits a request to initiate a new All-In-One operation using pre-existing inputs, with the
exception of input data, which is submitting along with the request.
Request takes binary file data as content, and on success will return one of two responses
depending on the type of operation:
l Asynchronous – response containing additional headers that specify the ID of the new
operation as well as link URLs that can be used to retrieve further information/cancel the
operation (Default)
l Synchronous – response (depending on the parameters specified) containing either:
l the absolute paths of the final output files produced (multiple spool files) or the
content of a final output file (single spool file)
l the absolute path or paths of the final output file or files produced (single or multiple
spool files respectively) (Get Result as Text Only)
Type: POST
URI:
/rest/serverengine/workflow/print/{dmConfigId}/{templateId}/{jcConfigId}/
{ocConfigId}
Parameters:
Path:
l dmConfigId – the Managed File ID (or Name) of the Data
Mapping configuration in File Store
l templateId – the Managed File ID (or Name) of the design
template in File Store
l jcConfigId – the Managed File ID (or Name) of the Job Creation
Preset in File Store (Optional – the value of "0" can be specified if
no preset is to be used)
l ocConfigId – the Managed File ID (or Name) of the Output
Creation Preset in File Store
Query:
l async – whether to run the operation asynchronously (Default
Page 559