REST API services

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

IEE Identity Sync REST API

The IEE Identity Sync REST APIs rely on the core reading API/libraries in IEE core.

The list of APIs can be viewed at the IEE API URL in the following format:

https://<APIServerFQDN>:<APIServerPort>/swagger/index.html

where <APIServerFQDN> is the fully qualified domain name of the server where IEE APIs are installed (for example: https://azr-iee webop2.ieeweb.test:12000/swagger/index.html) where<APIServerFQDN> is 12000 by default.

IdentitySyncApi

Screenshot of the IEE Identity Sync REST API.

IEE Reading REST API

The IEE Reading REST APIs rely on the core reading API/libraries in IEE core and support the streaming data functionality.

The list of APIs can be viewed at the IEE API URL in the following format:

https://<APIServerFQDN>:<APIServerPort>/swagger/index.html

where <APIServerFQDN> is the fully qualified domain name of the server where IEE APIs are installed (for example: https://azr-iee webop2.ieeweb.test:6001/swagger/index.html) where<APIServerFQDN> is 6001 by default.

ReadingsApi

Screenshot of the IEE Reading REST API.

IEE StreamData REST API

The IEE StreamData REST API service relies on the core reading API/libraries in IEE core and supports the streaming data functionality.

The API can be viewed at the IEE API URL in the following format:

https://<APIServerFQDN>:<APIServerPort>/swagger/index.html

where <APIServerFQDN> is the fully qualified domain name of the server where IEE APIs are installed (for example: https://azr-iee-webop2.ieeweb.test:10001/swagger/index.html) where<APIServerFQDN> is 10001 by default.

StreamDataApi

Screenshot of the IEE StreamData REST API service.

IEE Gateway REST API

The IEE Gateway REST API service relies on the core reading API/libraries in IEE core and supports the streaming data functionality.

The API can be viewed at the IEE API URL in the following format:

https://<APIServerFQDN>:<APIServerPort>/swagger/index.html

where <APIServerFQDN> is the fully qualified domain name of the server where IEE APIs are installed (for example: https://azr-iee-webop2.ieeweb.test:9001/swagger/index.html) where<APIServerFQDN> is 9001 by default.

GatewayApi

Screenshot of the IEE Gateway REST API service.