Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

alarm-controller

Get All Alarms (getAllAlarms)

Returns a page of alarms that belongs to the current user owner. If the user has the authority of 'Tenant Administrator', the server returns alarms that belongs to the tenant of current user. If the user has the authority of 'Customer User', the server returns alarms that belongs to the customer of current user. Specifying both parameters 'searchStatus' and 'status' at the same time will cause an error. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details.

Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.

get/api/alarms

Query parameters

searchStatus'ANY' | 'ACTIVE' | 'CLEARED' | 'ACK' | 'UNACK'

A string value representing one of the AlarmSearchStatus enumeration value

status'ACTIVE_UNACK' | 'ACTIVE_ACK' | 'CLEARED_UNACK' | 'CLEARED_ACK'

A string value representing one of the AlarmStatus enumeration value

assigneeIdstring

A string value representing the assignee user id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

pageSizeinteger required

Maximum amount of entities in a one page

pageinteger required

Sequence number of page starting from 0

textSearchstring

The case insensitive 'substring' filter based on of next alarm fields: type, severity or status

sortProperty'createdTime' | 'startTs' | 'endTs' | 'type' | 'ackTs' | 'clearTs' | 'severity' | 'status'

Property of entity to sort by

sortOrder'ASC' | 'DESC'

Sort order. ASC (ASCENDING) or DESC (DESCENDING)

startTimeinteger

The start timestamp in milliseconds of the search time range over the Alarm class field: 'createdTime'.

endTimeinteger

The end timestamp in milliseconds of the search time range over the Alarm class field: 'createdTime'.

fetchOriginatorboolean

A boolean value to specify if the alarm originator name will be filled in the AlarmInfo object field: 'originatorName' or will returns as null.

Response

OK

totalPagesinteger

Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria

totalElementsinteger

Total number of elements in all available pages

hasNextboolean

'false' value indicates the end of the result set

Example response

{
  "data": [
    {
      "id": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "ALARM"
      },
      "createdTime": 1634058704567,
      "tenantId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "TENANT"
      },
      "customerId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "CUSTOMER"
      },
      "type": "High Temperature Alarm",
      "originator": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "DEVICE"
      },
      "severity": "CRITICAL",
      "acknowledged": true,
      "assigneeId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "USER"
      },
      "startTs": 1634058704565,
      "endTs": 1634111163522,
      "ackTs": 1634115221948,
      "clearTs": 1634114528465,
      "assignTs": 1634115928465,
      "propagate": true,
      "propagateToOwner": true,
      "propagateToTenant": true,
      "originatorName": "Thermostat",
      "originatorLabel": "Thermostat label",
      "originatorDisplayName": "Thermostat",
      "assignee": {
        "id": {
          "id": "784f394c-42b6-435a-983c-b7beff2784f9",
          "entityType": "USER"
        }
      },
      "name": "High Temperature Alarm",
      "status": "ACTIVE_UNACK",
      "details": {}
    }
  ]
}