Actions60
- Alarm Actions
- Asset Actions
- Customer Actions
- Dashboard Actions
- Device Actions
- Entity Group Actions
- Relation Actions
- Telemetry Actions
Alarm → Get Highest Severity
AI-generatedSummary
Fetch the alarm with the highest severity for a given entity.
Inputs
- alarmEntityType (required) — Entity type to search within (e.g., DEVICE, ASSET, ENTITY_VIEW, CUSTOMER, DASHBOARD, USER, DATA_CONVERTER, INTEGRATION, SCHEDULER_EVENT).
- entityId (required) — ID of the entity whose alarms should be evaluated.
- searchStatus — Optional filter from AlarmSearchStatus enumeration (ANY, ACTIVE, CLEARED, ACK, UNACK).
- status — Optional filter from AlarmStatus enumeration (ACTIVE_UNACK, ACTIVE_ACK, CLEARED_UNACK, CLEARED_ACK).
Output shape
a single alarm object containing at least the severity and identifier fields
The response is not paginated; it returns the alarm record with the highest severity. Additional alarm fields may be present depending on ThingsBoard version.
Examples
Example 1: Get the most severe alarm on a device
resource=alarm, operation=Get Highest Severity, entityId=784f394c-42b6-435a-983c-b7beff2784f9, alarmEntityType=DEVICE
Example 2: Find the highest severity active alarm filtered by status
resource=alarm, operation=Get Highest Severity, entityId=123, searchStatus=ACTIVE, status=ACTIVE_UNACK
Example 3: Retrieve highest severity alarm across an asset group
resource=alarm, operation=Get Highest Severity, entityId=456, alarmEntityType=ASSET