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
Value: true)
l resultAsTxt – whether to retrieve the result as text (Synchronous
Only) (Default Value: false)
l createOnly – whether output is to be only created in the server
and not sent to it's final destination (Default Value: false)
l printRange – a specific range of records in the input data file to
restrict the print output to (No Default Value)
l filename – the file name of the data file to be uploaded (No
Default Value)
Request:
Add.
Headers:
auth_token – Authorization Token (if server security
settings enabled)
Content: Data File (File)
Content
Type:
application/octet-stream
Response:
Add.
Headers:
l operationId – Operation ID of new All-In-One
operation
l Link – Contains multiple link URLs that can be
used to retrieve further information/cancel the
operation
Content: –
Content
Type:
–
Status:
l 202 Accepted – Data file successfully uploaded
to File Store and creation of new operation
successful
l 400 Bad Request – Unable to locate one or more
inputs in File Store with Managed File ID(s)
Page 560