2019.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 Mapping Validation Result
Describes the result of a request to validate a data mapping operation, including a list of any
errors that occurred (used specifically with the Data Mapping service).
Structure
The structure consists of an object with the following name/value pairs:
l result – the overall result of the data mapping operation (value of either ERROR or OK) (type
of string)
l recordcount – the number of data records in the data file (type of number)
l errors – a list of errors that occurred during the mapping process, consisting of an array
of objects each with the following name/value pairs:
l record – the number of the erroneous record in the data file (type of number)
l reason – the mapping error/reason for this particular record (type of string)
Example
The following is an example of this structure:
{
"result": "ERROR",
"recordcount": 105,
"errors": [
{
"record": 20,
"reason": "Document: 20 Unparseable date: \"\""
},
{
"record": 45,
"reason": "Document: 45 Unparseable date: \"\""
},
{
"record": 97,
"reason": "Document: 97 Unparseable date: \"\""
}
]
}
Page 90