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

40169ccdec5c

alarm-controller

Get Alarm Info (getAlarmInfoById)

Fetch the Alarm Info object based on the provided Alarm Id. If the user has the authority of 'Tenant Administrator', the server checks that the originator of alarm is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the originator of alarm belongs to the customer. Alarm Info is an extension of the default Alarm object that also contains name of the alarm originator.

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

get/api/alarm/info/{alarmId}

Path parameters

alarmIdstring required

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

Response

OK

createdTimeinteger

Timestamp of the alarm creation, in milliseconds

typestring required

representing type of the Alarm

severity'CRITICAL' | 'MAJOR' | 'MINOR' | 'WARNING' | 'INDETERMINATE' required

Alarm severity

acknowledgedboolean required

Acknowledged

clearedboolean required

Cleared

startTsinteger

Timestamp of the alarm start time, in milliseconds

endTsinteger

Timestamp of the alarm end time(last time update), in milliseconds

ackTsinteger

Timestamp of the alarm acknowledgement, in milliseconds

clearTsinteger

Timestamp of the alarm clearing, in milliseconds

assignTsinteger

Timestamp of the alarm assignment, in milliseconds

propagateboolean

Propagation flag to specify if alarm should be propagated to parent entities of alarm originator

propagateToOwnerboolean

Propagation flag to specify if alarm should be propagated to the owner (tenant or customer) of alarm originator

propagateToTenantboolean

Propagation flag to specify if alarm should be propagated to the tenant entity

propagateRelationTypesstring[]

JSON array of relation types that should be used for propagation. By default, 'propagateRelationTypes' array is empty which means that the alarm will be propagated based on any relation type to parent entities. This parameter should be used only in case when 'propagate' parameter is set to true, otherwise, 'propagateRelationTypes' array will be ignored.

originatorNamestring

Alarm originator name

originatorLabelstring

Alarm originator label

originatorDisplayNamestring

Originator display name

namestring required

representing type of the Alarm

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

status of the Alarm

{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example response

{
  "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": {}
}