Rest Connector
REST Connector is a publishing server plug-in to connect publishing hub to arbitrary HTTP based RESTFul services. REST Connector acts as a restful client to the target REST API using URIs that can be configured in a configuration file. Query results will be filtered and mapped into publishing hub entity data objects using XPath or similar expressions.
If you are new to RestConnector configuration please have a look at our new tutorial Working example: Accessing wordpress.com.
If you are just interested in latest additions or fixes, please see Change log.
Getting Started
The RestConnector comes preinstalled but must be properly licensed and updated.
Explanation
Core concepts that are needed to understand the configuration and how-to sections.
Reference
Complete reference for all configuration elements, enumerations, and the connector API.
How-to Guides
Task-specific guides for common connector scenarios.
- How-to Guides
- Secure connection - HTTPS
- HATEOAS Queries
- Custom Domain Models and JAXB Processing
- Processing of TableData
- Reading from local file system
- Using POST instead of GET
- Mapping media assets and media objects
- Mapping metaData
- Using the searchStr parameter
- Save data to service
- Using entity references
- Query chaining
- Download media resources with proxy
- Recursive root entity from a flat list
- Fully dynamic URI
- Configuring cords
- Recursive root with parentId parameter
- Reading CSV data
- Payara system properties and aliases
- Hints for debugging
- Migrating from EasyRest
- Tester utility
Examples
Worked examples and configuration patterns.
- Worked out example: Accessing wordpress.com
- Simplistic configuration
- Full configuration example with detailed explanations
- Configuring a recursive root entity from one big flat file
- Fully dynamic URI
- Configuring cords
- Configuring a recursive root with parentId parameter