2021.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 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
- 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
If required, a Job Creation preset can also be referenced by specifying a Managed File ID or
Name.
The following options can be specified :
l Asynchronous – Run the All-In-One operation asynchronously with the operation
progress being displayed and the option to cancel the running operation.
l Create Only – Create the output in server but do not send spool file to its final destination.
In this example this would mean that the output files(s) would not be sent to the output
directory specified in the output creation preset.
l Get Result as Text – Return the result as text specifically. In this example this would
return the absolute path to the output file(s).
l Print Range – Restrict the print output to a specific range of records in the input data, not
a specific range of pages.
Lastly, select the Submit button to start the All-In-One operation.
If running the operation asynchronously, once the operation has started processing, the
Operation ID will be displayed in the Results area and the Cancel button will become enabled,
giving you the option to cancel the running operation.
The progress of the operation will be displayed in the progress bar, and once the All-in-One
operation has completed, the result will be returned and displayed to the Results area.
If running the operation synchronously, the result of the operation will simply be returned and
displayed to the Results area.
The result returned will be the either the absolute path(s) of the output files or the output file
itself.
Note
If the result returned is expected to be file data, then then a download link will be
displayed.
Further Reading
See the All-In-One Service page of the REST API Reference section for further detail.
Page 428