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
Usage
To run the example you first need to use the Browse button to select an appropriate JSON
Data File to use as an input using the selection dialog box.
Next, you need to enter the Managed File ID or Name of your template (previously uploaded
to the file store) into the appropriate text field.
Lastly, you can specify the following JSON Image Parameters to use when creating the preview
image
l Context – the context in the template to be used in the creation of the preview image
(Default value is determined by the first context in the template).
l Section – the section within the context specified to be used in the creation of the preview
image.
If unspecified, then the default value is determined by the value of the Context image
parameter specified.
For the Print context this will be all enabled sections, for the Email and Web contexts this
will be the default section.
l Type – the image type/format to be used in the creation of the preview image.
l DPI – the target resolution of the preview image in dots per inch (DPI)
l Archive – whether to return the resulting preview as a ZIP file/archive. The Default value
is determined automatically by the number of image files in the preview output.
If the Type image parameter is set to a value of PNG, then the following image parameter can
also be specified:
l Quality – the quality of the preview image (ranging in value from 0 - 100).
If the Context image parameter is set to a value of Print, then the following image parameters
can also be specified:
l Include Bleed – whether to include the bleed area in the preview image.
l Pages – the page range to be output in the preview image.
If unspecified, then the default value is determined by the value of the Archive image
parameter.
If the Archive image parameter is set to a value of False, then the default value will be 1.
If the Archive image parameter is set to a value of either Default or True, then the default
value will be * (all pages).
Page 315