2018.1
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
JSON Data Record Identifier List (with Parameters)
Describes a list of identifiers for multiple data entities (specifically data record entities), along
with additional parameters.
It is used specifically with the Data Record Entity service as input to the Get Multiple Data
Record Values (JSON) resource method. The value of the explicitTypes parameter
determines if the result returned is either a JSON Record Content Lists or JSON Record
Content Lists (Explicit Types) structure.
Structure
The structure consists of an object with the following name/value pairs:
l recordids – an array of data record entity identifiers (type of number)
l recursive – parameter to specify if all data tables within each data record should be
recursed and the values of any nested data records retrieved also (type of boolean)
l explicitTypes – parameter to specify if both data record values and data types are to be
retrieved (type of boolean)
Example
The following is an example of this structure:
{
"recordids": [ 12345, 23456, 34567 ],
"recursive": true,
"explicitTypes": false
}
Page 72