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
Uploading a Job Creation Preset to the File Store 172
Uploading an Output Creation Preset to the File Store 178
Working with the Entity Services 184
Finding Specific Data Entities in the Server 185
Finding all the Data Sets in the Server 220
Finding the Data Records in a Data Set 223
Finding all the Content Sets in the Server 227
Finding the Content Items in a Content Set 231
Finding all the Job Sets in the Server 235
Finding the Jobs in a Job Set 238
Working with the Workflow Services 241
Running a Data Mapping Operation 243
Running a Data Mapping Operation (Using JSON) 250
Running a Data Mapping Operation for PDF/VT File (to Data Set) 257
Running a Data Mapping Operation for PDF/VT File (to Content Set) 263
Running a Content Creation Operation for Print By Data Set 269
Running a Content Creation Operation for Print By Data Record (Using JSON) 275
Running a Content Creation Operation for Print By Data (Using JSON) 281
Creating a Preview PDF for Print By Data Record 287
Creating a Preview PDF for Print By Data 291
Creating a Preview PDF for Print By Data (Using JSON) 295
Creating a Preview Image By Data Record (Using JSON) 298
Creating a Preview Image By Data (Using JSON) 307
Running a Content Creation Operation for Email By Data Record (Using JSON) 317
Running a Content Creation Operation for Email By Data (Using JSON) 330
Creating Content for Web By Data Record 345
Creating Content for Web By Data Record (Using JSON) 351
Creating Content for Web By Data (Using JSON) 356
Running a Job Creation Operation By Content Set (Using JSON) 362
Running a Job Creation Operation By Content Set with Runtime Parameters (Using
JSON)
368
Running an Output Creation Operation By Job Set 377
Running an Output Creation Operation By Job Set (Using JSON) 385
Running an Output Creation Operation By Job (Using JSON) 393
Running an All-In-One Operation (Using JSON) 401
Running an All-In-One Operation with Adhoc Data 419
REST API Reference 429
Page 6