This milestone is part of the Beehive Roadmap. See the roadmap for full details of milestones and scheduling of milestones.
REST API
Beehive should expose a HTTP REST API. The intent is to allow other applications (both OpenRemote and external 3rd party applications) to interact with the database.
The REST API will evolve as new features and requirements are added. This milestone is not intended as a complete REST API implementation. Rather, it is a starting point to enable integration of other OpenRemote Manager applications in the version 1.0 of Beehive.
Required Operations
This iteration of the REST API should allow for the following operations:
- Export a LIRC configuration as a text file
- List all hardware vendors in the database
- List all models of a vendor in the database
Recommended reading on REST API design that should be studied first before submitting the API proposal of this milestone listed below. Especially recommend focusing on understanding the nature of stateless communication and using the natural HTTP features such as document linking, HTTP caching and MIME types.
Deliverables
- Documented REST API (final API for version 1.0 of Beehive)
- Implementation of REST API as JBoss AS deployable WAR
