Use the following APIs to retrieve notification instances.

Get Notification Instance by ID

Required Permissions

You must have the View Notification Instance permission to perform this operation.

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

string

Notification instance ID. (Mandatory)
Response 
{
  "id": "5bf29d8178d80c88c32sq819",
  "notificationDefinitionId": "5bf29d8178d80c88c89df352",
  "entityState": "ENTITY_CREATED",
  "entityId": "1234567890abcef1234567890abcef",
  "entityName": "TestEntity-001",
  "entityType": "TestEntity",
  "additionalDetails": [
    {
      "key": "temperature",
      "valueInt64": 20
    }
  ],
  "responseStatus": 500,
  "responseBody": "Internal Server Error",
  "status": "FAILED",
  "tenantId": "5beaa559a40a82f457340c4d",
  "createdTime": "1542626737552",
  "lastUpdatedTime": "1542626737566",
  "createdBy": "[email protected]",
  "lastUpdatedBy": "[email protected]",
  "updateVersion": 2
}

List All Notification Instances

Required Permissions

You must have the View Notification Instance permission to perform this operation.

API
/api/notification-instances
Method
GET
Required Parameters
None
Response 
{
  "notificationInstances": [
    {
      "id": "5bf29d8178d80c88c32sq819",
      "notificationDefinitionId": "5bf29d8178d80c88c89df352",
      "entityState": "ENTITY_CREATED",
      "entityId": "1234567890abcef1234567890abcef",
      "entityName": "TestEntity-002",
      "entityType": "TestEntity",
      "additionalDetails": [
        {
          "key": "temperature",
          "valueInt64": 20
        }
      ],
      "status": "FAILED",
      "responseStatus": 500,
      "responseBody": "Internal Server Error",
      "tenantId": "5beaa559a40a82f457340c4d",
      "createdTime": "1542626737552",
      "lastUpdatedTime": "1542626737566",
      "createdBy": "[email protected]",
      "lastUpdatedBy": "[email protected]",
      "updateVersion": 2
    },
    {
      "id": "6dc29d9378d80c88c25ed317",
      "notificationDefinitionId": "5bf29d8243d80c88c25an910",
      "entityState": "ENTITY_CREATED",
      "entityId": "1234567890abcef1234567890abcef",
      "entityName": "TestEntity-003",
      "entityType": "TestEntity",
      "additionalDetails": [
        {
          "key": "CPU",
          "valueInt64": 100
        }
      ],
      "status": "NOTIFIED",
      "tenantId": "5beaa559a40a82f457340c4d",
      "createdTime": "1542622648733",
      "lastUpdatedTime": "1542622648744",
      "createdBy": "[email protected]",
      "lastUpdatedBy": "[email protected]",
      "updateVersion": 2
    }
  ],
  "pageInfo": {
    "page": 1,
    "pageSize": 10,
    "totalElements": "2",
    "totalPages": "1"
  }
}