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
Find Data Entity
Submits data entity search criteria to the PlanetPress Connect Server.
Request takes a JSON Search Parameters structure as content and on success returns a
response containing JSON Identifier Lists (with Sort Key) of the data entity IDs matching the
search criteria.
Type: PUT
URI:
/rest/serverengine/entity/find
Parameters: -
Request:
Add.
Headers:
auth_token – Authorization Token (if server security
settings enabled)
Content: JSON Search Parameters containing search
criteria/rules
Content
Type:
application/json
Response:
Add.
Headers:
-
Content: JSON Identifier Lists (with Sort Key) containing all the
entities matching the search criteria
Content
Type:
application/json
Status:
l 200 OK – Search request successfully executed
l 401 Unauthorized – Server authentication required
Page 407