RESTful Interface Design for Entity Version

Owned by Odysseas Pentakalos
Last updated: May 12, 2021 by Sophia

RESTful Interface Design for Entity Version

This section of the documentation describes the new web services interface which is independent of the model of the entity that is managed by an instance of OpenEMPI. Since a single instance of OpenEMPI can manage multiple different entity types, he caller must specify the model to which the operation should be applied to by passing the entity name as a key parameter to every resource available.

Starting with version 3.6.0 and 4.0.0 of OpenEMPI the REST API has been expanded considerably to include many more resources. The REST API exposes the full functionality of the software and goes way beyond the list of resources documented on this page. There is now a comprehensive programmers guide for the REST API and it is made available with distributions of the Professional Edition of the software. You can also access the programmers guide here along with the community edition during your evaluation of the software.