1.7
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
- 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 Acknowledgments
REST API Reference
The PlanetPress Connect REST API defines a number of RESTful services that facilitate
various functionality within the server during workflow processing.
The following table is a summary of the services available in the PlanetPress Connect REST
API:
Service
Name
Internal Name Description
Authentication
Service
AuthenticationRestService Exposes methods for authenticated
access (login & password) to the
PlanetPress Connect REST API. Uses
a combination of basic and token
based authorisation.
Content
Creation
Service
ContentCreationRestService Exposes methods for the manual
creation, monitoring & cancellation of
new Print context based content
creation operations within the
workflow, including a method for
accessing the result of a successful
operation. Also exposes methods for
generating preview PDFs of print
output for single data records.
Content Item
Entity Service
ContentItemEntityRestService Exposes methods specific to the
Content Item entity type including
property value accessor methods and
an associated data record lookup
method.
Content Set
Entity Service
ContentSetEntityRestService Exposes methods specific to the
Content Set entity type including
property value accessor methods,
methods to access all content sets and
Page 277