ThingsBoardInstall

Summary

Fetch alarms for a specified originator entity with optional filtering and pagination

Inputs

• authentication — Authentication method to use (API Key or Username/Password)
• pageSize — Maximum number of alarms per page (minimum 1)
• page — Zero‑based page index for pagination
• sortOrder — Sort order for results, either ASC or DESC
• alarmEntityType (required) — Entity type of the originator (e.g., DEVICE, ASSET, CUSTOMER)
• entityId (required) — ID of the originator entity
• searchStatus — Alarm search status filter (ANY, ACTIVE, CLEARED, ACK, UNACK)
• status — Alarm status filter (ACTIVE_UNACK, ACTIVE_ACK, CLEARED_UNACK, CLEARED_ACK)
• alarmTextSearch — Case‑insensitive substring search on alarm type, severity or status
• alarmSortProperty — Property used for sorting the results
• startTs — Start timestamp (milliseconds since epoch) for time range filter
• endTs — End timestamp (milliseconds since epoch) for time range filter
• fetchOriginator — Whether to include the originator entity details in the response

Output shape

array of alarm objects

Paginated via page and pageSize; includes optional fields such as originator when fetchOriginator is true; may contain standard alarm fields (id, type, severity, status, createdTime, etc.)

Examples

Example 1: Retrieve the first page of alarms for a DEVICE with ID 784f394c-42b6-435a-983c-b7beff2784f9

resource=Alarm, operation=Get by originator, alarmEntityType=DEVICE, entityId=784f394c-42b6-435a-983c-b7beff2784f9, pageSize=10, page=0

Example 2: Get active alarms for an ASSET with ID 123e4567-e89b-12d3-a456-426614174000, filtering by status ACTIVE_ACK

resource=Alarm, operation=Get by originator, alarmEntityType=ASSET, entityId=123e4567-e89b-12d3-a456-426614174000, status=ACTIVE_ACK, pageSize=5

Example 3: Search alarms containing the text 'temperature' and include the originator

resource=Alarm, operation=Get by originator, alarmTextSearch=temperature, fetchOriginator=true, pageSize=20

Links

• n8n community nodes installation guide