Triggered Alerts

The 'triggered alerts' API allows viewing the alerts that have been triggered and are associated with the various devices in the system. Administrator or super administrator permissions are required.

GET /triggeredAlert

The GET /triggeredAlert endpoint provides a list of triggered alerts that can be filtered by the following fields:

• 'time' (optional): time when the last alert was triggered.
• 'alertId' (optional): alert identifier.
• 'alertName' (optional): name of the alert.
• 'alertState' (optional): state of the alert; there are three states: 'activated', 'disabled', or 'discharged'.
• 'alertType' (optional): type of alert; there are two types: 'EXPRESSION' and 'LAST_COMMUNICATION'.
• 'alertEntityId' (optional): identifier of the device associated with the alert in the context broker.
• 'alertOrganization' (optional): organization to which the alert belongs.
• 'alertDeviceId' (optional): identifier of the device associated with the alert.
• 'alertDeviceName' (optional): name of the device associated with the alert.
• 'alertDeviceType' (optional): type of the device associated with the alert.
• 'alertPriority' (optional): priority of the alert; there are three levels: 'CRITICAL', 'MAJOR', and 'MINOR'.
• 'alertSeverity' (optional): severity of the alert; there are three levels: 'CRITICAL', 'MAJOR', and 'MINOR'.
• 'alertVerticals.verticalId' (optional): identifier of a vertical of the device associated with the alert.
• 'alertVerticals.name' (optional): name of a vertical of the device associated with the alert.
• 'alertAttributeConstraints.id' (optional): identifier of the expression triggering an alarm.
• 'alertAttributeConstraints.name' (optional): name of the expression triggering an alarm.
• 'alertAttributeConstraints.operator' (optional): operator of the expression triggering an alarm; the following types exist: 'EQUAL_TO', 'GREATER_THAN', 'LESS_THAN', 'GREATER_THAN_OR_EQUAL', 'LESS_THAN_OR_EQUAL', 'NOT_EQUAL', 'BETWEEN'.
• 'alertAttributeConstraints.value' (optional): expected value triggering an alarm.
• 'alertAttributeConstraints.value2' (optional): second expected value triggering an alarm.
• 'alertTimegap' (optional): time that must pass for an alarm to be triggered.
• 'alertTimegapunit' (optional): time metric to trigger an alert.

GET /triggeredAlert/paged

The GET /triggeredAlert/paged endpoint provides a paginated list of triggered alerts that can be filtered by the following fields:

• 'page' (optional): page number to display.
• 'size' (optional): number of elements per page.
• 'sort' (optional): sorting order of the elements; can be ascending (ASC) or descending (DESC) and is based on any of the attributes by which to filter.
• 'time' (optional): time when the last alert was triggered.
• 'alertId' (optional): alert identifier.
• 'alertName' (optional): name of the alert.
• 'alertState' (optional): state of the alert; there are three states: 'activated', 'disabled', or 'discharged'.
• 'alertType' (optional): type of alert; there are two types: 'EXPRESSION' and 'LAST_COMMUNICATION'.
• 'alertEntityId' (optional): identifier of the device associated with the alert in the context broker.
• 'alertOrganization' (optional): organization to which the alert belongs.
• 'alertDeviceId' (optional): identifier of the device associated with the alert.
• 'alertDeviceName' (optional): name of the device associated with the alert.
• 'alertDeviceType' (optional): type of the device associated with the alert.
• 'alertPriority' (optional): priority of the alert; there are three levels: 'CRITICAL', 'MAJOR', and 'MINOR'.
• 'alertSeverity' (optional): severity of the alert; there are three levels: 'CRITICAL', 'MAJOR', and 'MINOR'.
• 'alertVerticals' (optional): verticals of the device associated with the alert.
• 'alertAttributeConstraint' (optional): expression triggering an alarm.
• 'alertTimegap' (optional): time that must pass for an alarm to be triggered.
• 'alertTimegapunit' (optional): time metric to trigger an alert.