<< Click to Display Table of Contents >> Navigation:  REST API > EQuIS REST API Core

The API core implements the core functionality for EQuIS Enterprise (e.g., Widgets, EDP Workflow, Reporting). Specific resources within the API.Core are defined below. See the Swagger documentation for details.

 

api/config – Manage application configuration data in ST_CONFIG table. Many of these endpoints require Administrator rights.

 

api/dashboard – Used by the Enterprise web application to manage dashboards and widgets.

 

api/download – Access BLOB data stored in the DT_FILE, ST_NOTICE_ATTACHMENT, ST_FILE_REGISTRATION, SDT_DASHBOARD, and SDT_WIDGET_TYPE tables.

 

api/edp – Enterprise EDP and EDD access.

 

api/eia – Management of Enterprise EQuIS Information Agents (EIAs).

 

api/explorer – Ported from EQuIS 6 to facilitate the Explorer widget. Some aspects are not RESTful.

 

api/facilities – Facility and Location objects with support for Esri mapping services. Some aspects are not RESTful by design to support Esri’s API. The Samples and Tests routes are not implemented yet.

 

api/files – Management of data in the DT_FILE table.

 

api/formats – Management of EDP format registration used by Enterprise EDP.

 

api/groups – Management of group data in RT_GROUP and RT_GROUP_MEMBER. Much of this is still copied from EQuIS 6 and is not very RESTful. This is mostly used by the Explorer widget. Until we get a handle on this you are encouraged to ask for help in using these routes as they’re not intuitive.

 

api/logs – Management of data in the ST_LOG table. It does not provide access to other Log4Net file appenders.

 

api/modules – Management of EQuIS Product module information with limited deployment support.  

 

api/notices – Management of EQuIS notifications.

 

api/odata – OData implementation as of the 7.20.3 Build. Requires ALS role membership.

 

api/refvals – Read-only access to Reference Values.

 

api/registration – License registration and use.

 

api/reports – Access to EQuIS Reporting capabilities.

 

api/token – Authentication token management.

 

api/users – Administrator access to user management and non-admin user profile management.

 

api/workflow – EQuIS Enterprise Workflow configuration and management.