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
Service Handshake 737
Service Version 739
File Store Service 741
Service Handshake 743
Download Managed File or Directory 745
Download Contents of Managed Directory 747
Delete Managed File or Directory 752
Get Report 755
List Resources 758
Managed File or Directory Exists 762
Upload Data File 765
Upload Data Mapping Configuration 768
Upload Template 771
Upload Job Creation Preset 774
Upload Output Creation Preset 777
Service Version 780
Job Creation Service 782
Cancel an Operation 784
Get All Operations 787
Get Progress of Operation 790
Get Result of Operation 793
Process Job Creation 796
Process Job Creation (By Content Set) (JSON) 799
Process Job Creation (By Content Set) (Runtime Parameters) (JSON) 801
Process Job Creation (By Job Set Structure) (JSON) 805
Service Handshake 808
Service Version 810
Job Entity Service 812
Get Content Items for Job 813
Get Job Metadata Properties 816
Get Job Properties 819
Get Job Segments for Job 822
Service Handshake 825
Service Version 827
Update Job Metadata Properties 829
Update Job Properties 832
Update Multiple Job Properties 835
Page 9