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
Running a Job Creation Operation (Using JSON)
Problem
You want to run a job creation operation to produce a Job Set using a job creation preset and
an existing set of Content Sets as inputs.
Solution
The solution is to make a series of requests using the following URIs and method types to
submit, monitor progress and ultimately retrieve the result of the job creation operation. There is
also the option of cancelling an operation during processing if required. These requests can be
submitted via the Job Creation REST service:
Process Job Creation
(JSON)
/rest/serverengine/workflow/jobcreation/{configId}
POST
Get Progress of
Operation
/rest/serverengine/workflow/jobcreation/getProgress/
{operationId}
GET
Get Result of Operation
/rest/serverengine/workflow/jobcreation/getResult/
{operationId}
POST
Cancel an Operation
/rest/serverengine/workflow/jobcreation/cancel/
{operationId}
POST
Example
HTML5
jc-process-json.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Process Job Creation (JSON) Example</title>
<script src="../../common/lib/js/jquery-
3.2.1.min.js"></script>
<script src="../../common/js/common.js"></script>
<script src="js/jc-process-json.js"></script>
Page 263