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
"parameters": {
"FirstName": "Benjamin",
"InvoiceDueAmount": 123.45,
"InvoiceDueDate": "2020-03-10",
"InvoiceOverdue": true
}
},
"outputcreation":
{
"config": "5678",
"createOnly": false
}
}
JSON Bitmap Parameters
Describes a list of parameters used specifically in the rasterization of a PDF, PS, AFP or PCL
file, defining which pages of the source file have to be converted to a bitmap and the properties
of the resulting bitmap(s).
Structure
The structure consists of an object with the following optional name/value pairs:
l type – the image type/format to be used in the creation of the image (value of either jpg,
jpeg or png)
(type of string – default value of jpg)
l pages – the page range to be output; this counts over all pages even if one of the sections
is configured to restart page numbers
(type of string – default value is determined by the value of the archive parameter. If the
archive parameter is specified to false, then the default value will be 1. If the archive
parameter is either omitted or specified to a value of true, then the default value will be *
(all pages) )
l archive – whether to return the result as a ZIP file/archive; true means return the result as
ZIP file, false as a JPEG or PNG file
(type of boolean – default value is automatic: false if the output consists of a single file,
true if the output consists of multiple files)
l dpi – the target image resolution in dots per inch (DPI)
(type of number – default value of 96)
l scale – the scale of the target image
(type of float – default value of 1.0)
Page 51