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
job creation operations within the
workflow, including a method for
accessing the result of a successful
operation.
Job Entity
Service
JobEntityRestService Exposes methods specific to the Job
entity type including property and
metadata property value accessor
methods, a method to access the
content items contained within a
specific job, and a method to access
the job segment IDs contained within a
specific job.
Job Segment
Entity Service
JobSegmentEntityRestService Exposes methods specific to the Job
Segment entity type including
metadata property value accessor
methods, and a method to access the
document set IDs contained within a
specific job segment.
Job Set Entity
Service
JobSetEntityRestService Exposes methods specific to the Job
Set entity type including property and
metadata property value accessor
methods, methods to access all jobs
sets and delete specific data sets, and
a method to access the job IDs
contained within a specific job set.
Output
Creation
Service
OutputCreationRestService Exposes methods for the manual
creation, monitoring & cancellation of
output creation operations within the
workflow, including methods for
accessing the result of a successful
operation.
Page 280