2018.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
- Running a Content Creation Operation for Print By Data Record (Using JSON)
- Running a Content Creation Operation for Email By Data Record (Using JSON)
- Creating Content for Web By Data Record
- Creating Content for Web By Data Record (Using JSON)
- Running a Job Creation Operation (Using JSON)
- Running an Output Creation Operation
- Running an Output Creation Operation (Using JSON)
- Running an Output Creation Operation By Job (Using JSON)
- Running an All-In-One Operation (Using JSON)
- REST API Reference
- Authentication Service
- Content Creation Service
- Service Handshake
- Process Content Creation
- Process Content Creation (By Data Record) (JSON)
- Process Content Creation (By Data) (JSON)
- Create Preview PDF
- Create Preview PDF (By Data Record)
- Create Preview PDF (By Data) (JSON)
- Get All Operations
- Get Progress of Operation
- Get Result of Operation
- Cancel an Operation
- Service Version
- Content Item Entity Service
- Content Set Entity Service
- Data Record Entity Service
- Data Set Entity Service
- Data Mapping Service
- Document Entity Service
- Document Set Entity Service
- Content Creation (Email) Service
- Entity Service
- File Store Service
- Content Creation (HTML) Service
- Job Creation Service
- Job Entity Service
- Job Segment Entity Service
- Job Set Entity Service
- Output Creation Service
- All-In-One Service
- Copyright Information
- Legal Notices and Acknowledgements
Uploading a Job Creation Preset to the File Store 135
Uploading an Output Creation Preset to the File Store 141
Working with the Entity Services 147
Finding Specific Data Entities in the Server 148
Finding all the Data Sets in the Server 180
Finding the Data Records in a Data Set 183
Finding all the Content Sets in the Server 187
Finding the Content Items in a Content Set 190
Finding all the Job Sets in the Server 195
Finding the Jobs in a Job Set 198
Working with the Workflow Services 201
Running a Data Mapping Operation 202
Running a Data Mapping Operation (Using JSON) 209
Running a Data Mapping Operation for PDF/VT File (to Data Set) 216
Running a Data Mapping Operation for PDF/VT File (to Content Set) 222
Running a Content Creation Operation for Print 228
Running a Content Creation Operation for Print By Data Record (Using JSON) 234
Running a Content Creation Operation for Email By Data Record (Using JSON) 241
Creating Content for Web By Data Record 251
Creating Content for Web By Data Record (Using JSON) 257
Running a Job Creation Operation (Using JSON) 263
Running an Output Creation Operation 269
Running an Output Creation Operation (Using JSON) 276
Running an Output Creation Operation By Job (Using JSON) 284
Running an All-In-One Operation (Using JSON) 292
REST API Reference 308
Authentication Service 318
Service Handshake 319
Authenticate/Login to Server 320
Service Version 322
Content Creation Service 323
Service Handshake 325
Process Content Creation 326
Process Content Creation (By Data Record) (JSON) 328
Process Content Creation (By Data) (JSON) 330
Create Preview PDF 332
Create Preview PDF (By Data Record) 334
Page 6