2022.2
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
- Service Handshake
- Download Managed File or Directory
- Download Contents of Managed Directory
- Delete Managed File or Directory
- Get Report
- List Resources
- Managed File or Directory Exists
- Upload Data File
- Upload Data Mapping Configuration
- Upload Template
- Upload Job Creation Preset
- Upload Output Creation Preset
- Service Version
- 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
Uploading a Job Creation Preset to the File Store 170
Uploading an Output Creation Preset to the File Store 176
Working with the Entity Services 182
Finding Specific Data Entities in the Server 183
Finding all the Data Sets in the Server 218
Finding the Data Records in a Data Set 221
Finding all the Content Sets in the Server 225
Finding the Content Items in a Content Set 229
Finding all the Job Sets in the Server 233
Finding the Jobs in a Job Set 236
Working with the Workflow Services 239
Running a Data Mapping Operation 241
Running a Data Mapping Operation (Using JSON) 248
Running a Data Mapping Operation for PDF/VT File (to Data Set) 255
Running a Data Mapping Operation for PDF/VT File (to Content Set) 261
Running a Content Creation Operation for Print By Data Set 267
Running a Content Creation Operation for Print By Data Record (Using JSON) 273
Running a Content Creation Operation for Print By Data (Using JSON) 279
Creating a Preview PDF for Print By Data Record 285
Creating a Preview PDF for Print By Data 289
Creating a Preview PDF for Print By Data (Using JSON) 293
Creating a Preview Image By Data Record (Using JSON) 296
Creating a Preview Image By Data (Using JSON) 305
Running a Content Creation Operation for Email By Data Record (Using JSON) 315
Running a Content Creation Operation for Email By Data (Using JSON) 328
Creating Content for Web By Data Record 343
Creating Content for Web By Data Record (Using JSON) 349
Creating Content for Web By Data (Using JSON) 354
Running a Job Creation Operation By Content Set (Using JSON) 360
Running a Job Creation Operation By Content Set with Runtime Parameters (Using
JSON)
366
Running an Output Creation Operation By Job Set 375
Running an Output Creation Operation By Job Set (Using JSON) 383
Running an Output Creation Operation By Job (Using JSON) 391
Running an All-In-One Operation (Using JSON) 399
Running an All-In-One Operation with Adhoc Data 417
REST API Reference 427
Page 5