REST APIs

IEE uses several representational state transfer (REST) application programming interface (API) services to route data between IEE components and other system components.

Introduced in Edge Explorer 2.3, the IEE StreamData API service retrieves near real-time reading data every few minutes by leveraging the Integration Management Service (IMS) with an in-memory database for optimal performance.

The IEE Reading API service retrieves historical reading data from the IEE database, and the IEE Gateway API service combines the recent raw reading data from the IEE StreamData API with the historical reading data from the IEE Reading API. The IEE Gateway API provides the returned data in either JavaScript Object Notation (JSON) format or IEE Common Reading Format (CRF). Any readings with MISSING or EMPTY statuses are omitted.

Note: Readings from the IEE Reading API receive a higher priority, and readings from the IEE StreamData API are used to fill the gaps designated as MISSING or EMPTY data.

Refer to the following topics for more information about the REST API services:

• Generating an Authorization token from the Identity Sync service

• IEE REST API general guidelines

• IEE Configuration REST API

• IEE Gateway REST API

• IEE Reading REST API

• IEE Settlements REST API

• IEE Stream Data REST API

• IEE System Configuration REST API

• IEE Task REST API

• IEE Validation Estimation (VE) REST API

• IEE Web UI REST API

Note: Additional information on each REST API can be found on the applicable Swagger page.