1.5
Table Of Contents
- Table of Contents
- Welcome to the PlanetPress Connect REST API Cookbook
- Technical Overview
- Working Examples
- 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
- Content Creation (Email) Service
- File Store Service
- Content Creation (HTML) Service
- Job Creation Service
- Job Entity Service
- Job Set Entity Service
- Output Creation Service
- All-In-One Service
- Copyright Information
- Legal Notices and Acknowledgments
Service
Name
Internal Name Description
Data Record
Entity Service
DataRecordEntityRestService Exposes methods specific to the Data
Record entity type including accessor
methods for data records and the value
& property values for a specific data
record.
Data Set
Entity Service
DataSetEntityRestService Exposes methods specific to the Data
Set entity type including property value
accessor methods, methods to access
all data sets and delete specific data
sets, and a method to access the data
record IDs contained within a specific
data set.
Data Mapping
Service
DataminingRestService Exposes methods for the manual
creation, monitoring & cancellation of
data mapping operations within the
workflow, including a method for
accessing the result of a successful
operation. Also exposes methods for
basic data mapping pass-throughs
specific to PDF VT data files.
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.
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 includes generic
Page 212