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
and/or Name(s) specified
l 401 Unauthorized – Server authentication
required
l 403 Forbidden – Server authentication has failed
or expired
l 500 Internal Server Error – General error with
running the All-In-One Process or a Specific
error relating to the uploading of the data file or
an individual workflow process (see error
description)
Response
(Synchronous):
Add.
Headers:
–
Content: Absolute Paths of the Output Files or the Output File
itself
Content
Type:
application/octet-stream
Status:
l 200 OK – Data file uploaded to File Store, and a
new operation was created and completed
successfully with the result returned
l 400 Bad Request – Unable to locate one or more
inputs in File Store with Managed File ID(s)
and/or Name(s) specified
l 401 Unauthorized – Server authentication
required
l 403 Forbidden – Server authentication has failed
or expired
l 500 Internal Server Error – General error with
running the All-In-One Process or a Specific
error relating to the uploading of the data file or
an individual workflow process (see error
description)
Page 561