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
Specific Structures
Specific JSON structures used in the PlanetPress Connect REST API include the following:
l JSON Identifier (Managed File)
l JSON Identifier (with Output Parameters)
l JSON Identifier List (with Output Parameters)
l JSON Record Content List
l JSON Record Content Lists
l JSON Record Content List (Explicit Types)
l JSON Record Content Lists (Explicit Types)
l JSON Record Content List (Fields Only)
l JSON Record Content Lists (Fields Only)
l JSON New Record List
l JSON New Record Lists
l JSON Record Data List
l JSON Content Item Identifier List
l JSON Data Record Identifier
l JSON Data Record Identifier List (with Parameters)
l JSON Identifier List (with Email Parameters)
l JSON Record Data List (with Email Parameters)
l JSON HTML Parameters List
l JSON Job Set Structure
l JSON All-In-One Configuration
l JSON Page Details Summary
l JSON Page Details List
l JSON Data Mapping Validation Result
l JSON Search Parameters
l JSON Identifier Lists (with Sort Key)
l JSON Operations List
Page 35