Monitor IE Device APP¶

This document highlights monitor the status and statistics of IE Device apps on IEM, the following HTTP request you may need related API documentation:

a POST request with your username and password and receive a lightweight token that will enable you as a user to authenticate future requests.
a GET request to receive the ID of the IE Device that you would like to get the installed applications.
a GET request to receive the applications installed on the IE Device.
a GET request to receive the statistics of a specific application installed on the IE Device.

Get authentication token for IEM API¶

See Authentication guide.

Get target Industrial Edge Device ID¶

To get the IE Device statistics, you require device IDs as unique identifier of the target devices. Use this request to list all available Industrial Edge Devices including the device ID:

curl -i -X GET \
-H "Authorization:<your-authorization-token>" \
**'https://<your-iem-url>/portal/api/v1/devices'**

A successful response looks like this:

{
  "data": [
    {
      "userId": "c0bc43d7b7544bb9a45f2c9e3d30e525",
      "deviceId": "fbbeb5943ed244a1ab38bdd19b80a3ff",
      "deviceName": "ied-iem",
      "deviceStatus": "ACTIVE",
      "platformId": "8773f1b11586405b91828b99ad91c177",
      "swPlatformId": "26592f675aeb4427b34a72784c8983ca",
      "createdDate": 1673942712000,
      "modifiedDate": 1673946633000,
      "softwarePlatformName": "DOCKER_COMPOSE"
    }
  ],
  "pageNo": 1,
  "totalPages": 1,
  "pageSize": 5,
  "totalCount": 1
}

List Installed Apps on IE Devices¶

You can get all the applications installed on a specific IE Device or all IE Devices. If you don't add the specific device id as the query field, then you will get all applicaitons installed on all IE Devices of the IEM, if you assigned the specific device id, then you will get the applications installed on this IE Device. use the request:

curl -i -X GET \
-H "Authorization:<your-authorization-token>" \
'https://<your-iem-url>/portal/api/v1/devices/installed-apps?deviceId=<your-device-id>'

A successful response looks like this:

{
  "data": [
    {
      "applicationId": "093751e589e040aca13f4aaefd2f62a9",
      "icon": "",
      "title": "test",
      "deviceId": "093751e589e040aca13f4aaefd2f62a9",
      "deviceName": "testDevice",
      "versionId": "PKF5CMDhyFUndKy0TciuWPKpR9ITlkSp",
      "versionNumber": "0.0.1",
      "status": "REVIEWED"
    }
  ]
}

List App Statistics¶

List app statistics on IE Device. You need the unique device ID and the unique app ID, use the request:

curl -i -X GET \
-H "Authorization:<your-authorization-token>" \
'https://<your-iem-url>/portal/api/v1/devices/<your-device-id>/installed-apps/<your-app-id>/statistics'

A successful response looks like this:

{
  "deviceAppStatisticsData": "\\{\"status\":\"Active\",\"time\":\"2022-12-19 07:14:06.319079052 +0000 UTC m=+30.002882942\"\\}"
}