Use the following APIs to view system notifications. System notifications are generated when there is a system downtime. The notifications are sent to the users through email or displayed on the UI.

Required Permissions

You must have the View System Notification Instance permission to perform these operations.

Get System Notification Instances

Description

Get a list of system notification instances.

API
/api/system-notification-instances
Method
GET
Required Parameters
None
Response Example 
{
   "systemNotificationInstances": [
       {
           "title": "Sample system notification",
           "content": "Sample content",
           "startTime": 1568270646743,
           "endTime": 1568356200000,
           "consoleParameters": {},
           "emailParameters": {},
           "status": "INSTANTIATED",
           "orgId": "eb962043-3bc4-43a5-afe5-f3d1d7c97d8a",
           "createdTime": 1568885017232,
           "lastUpdatedTime": 1568885017232,
           "updateVersion": 1,
           "createdBy": "25cdc85d-b6f2-4837-88ea-74b809e34e63",
           "lastUpdatedBy": "25cdc85d-b6f2-4837-88ea-74b809e34e63",
           "expireAt": 1571477017232,
           "id": "a9451b48-f664-4555-a23b-8993019b8539"
       }
   ],
   "pageInfo": {
       "totalPages": 1,
       "page": 1,
       "pageSize": 10,
       "totalElements": 1
   }
}

Get a System Notification Instance by ID

Description

Get a system notification instance by ID.

API
/api/system-notification-instances/{id}
Method
GET
Required Parameters
Name Description
id

string

System notification ID.
Response Example 
{
  "title": "System downtime",
  "content": "System downtime on 1st Feb between 1 AM to 3AM",
  "startTime": 1549279788621,
  "endTime": 1549279788621,
  "status": "INSTANTIATED",
  "tenantId": "7df0d3ad-01c9-4d16-a39c-96ca8c0e0625",
  "createdTime": 1549367946749,
  "lastUpdatedTime": 1549368052222,
  "updateVersion": 2,
  "createdBy": "nodemanagement@iotc-system",
  "lastUpdatedBy": "nodemanagement@iotc-system",
  "expireAt": 1551959946749,
  "id": "4bfa3f84-e67d-4cea-85bb-2e5d923b2fc0"
}