2019.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
- 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
Table of Contents
Table of Contents 5
Welcome to the PlanetPress Connect REST API Cookbook 12
Technical Overview 13
Workflow & Workflow Processes 14
Data Mapping 15
Content Creation 16
Job Creation 17
Output Creation 18
All-In-One 19
Input Files 21
Data Entities 22
Data Set & Data Record Entities 22
Content Set & Content Item Entities 23
Job Set & Job Entities 24
Workflow Operations 26
Asynchronous Operations 26
Synchronous Operations 27
JSON Structures 28
Common Structures 29
Specific Structures 35
Working Examples 102
Getting Started 103
Requirements & Installation 104
Structure of the Working Examples 106
HTML Input Placeholders & Multiple Value Fields 108
Display of Working Example Results 109
Using the Working Examples with Server Security 110
Server Security & Authentication 111
Authenticating with the Server 112
Working with the File Store 117
Uploading a Data File to the File Store 118
Uploading a Data Mapping Configuration to the File Store 123
Uploading a Design Template to the File Store 129
Page 5