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
Service
Name
Internal Name Description
metadata property value accessor
methods, and a method to access the
document IDs contained within a
specific document set.
Content
Creation
(Email)
Service
EmailExportRestService Exposes methods for the manual
creation, monitoring & cancellation of
new Email context based content
creation operations within the
workflow, including a method for
accessing the result of a successful
operation.
Entity Service EntityRestService Exposes a method for the selection of
data (of a specific entity type) using
various search criteria.
File Store
Service
FilestoreRestService Exposes methods specific to file store
operations in PlanetPress Connect
including the upload of data files, data
mapping configurations, design
templates, job creation presets &
output creation presets. Also exposes
methods for the download and deletion
of existing managed files in the file
store.
Content
Creation
(HTML)
Service
HTMLMergeRestService Exposes methods for the manual
creation of new Web context based
content. Also exposes an additional
method to access the resources
withing the Web context of a design
template.
Job Creation
Service
JobCreationRestService Exposes methods for the manual
creation, monitoring & cancellation of
Page 279