Alarms

Introduction

The OpenGate API query enables the retrieval of all raised alarms during the operation. This API allows for the retrieval of the list of alarms, thereby providing a plethora of options for:

  • Filter (See Specific Filter Fields)
  • Order (see Sorting)
  • Select Required Fields (see Selecting)
  • Summary (see Summary)

HTTP Header Options

It is possible to obtain the results in two different formats, see HTTP Header Options:

  • JSON format (default)
  • CSV format

Alarm Summary

This section lets users get a summary of alarms. The alarm summary allows the use of filters and grouping, though this is not a mandatory feature. If no filters are specified, a summary of all alarms will be displayed. Furthermore, the summary response can be filtered using the following parameters: alarm.name, alarm.rule, alarm.status, and alarm.severity.

Grouping resctriction

Please note that if a parameter other than those specified above is used, a 400 BadRequest error will be returned.

The following example illustrates the functionality of the default filtering and grouping options.

Request

{
  "filter": {}
}

Response

{
  "summary": {
    "date": "2020-08-14T11:06:26.04Z",
    "count": 6,
    "summaryGroup": [
      {
        "severity": {
          "count": 6,
          "list": [
            {
              "count": 1,
              "name": "URGENT"
            },
            {
              "count": 3,
              "name": "CRITICAL"
            },
            {
              "count": 2,
              "name": "INFORMATIVE"
            }
          ]
        }
      },
      {
        "rule": {
          "count": 3,
          "list": [
            {
              "count": 1,
              "name": "alarmForSubsInDevice"
            },
            {
              "count": 1,
              "name": "alarmForDevice"
            },
            {
              "count": 1,
              "name": "alarmForSubscription"
            }
          ]
        }
      },
      {
        "status": {
          "count": 3,
          "list": [
            {
              "count": 3,
              "name": "OPEN"
            }
          ]
        }
      },
      {
        "name": {
          "count": 3,
          "list": [
            {
              "count": 3,
              "name": "identificationConflict"
            }
          ]
        }
      }
    ]
  }
}
Default number of items returned

For more detailed information, please refer to the summary of API specifications.

API Specifications