Accepts one of the following messages:

• #0measurement_alarm

  measurement alarm event

  • application/json

  Payload

  Expand all

  allOf

  Consists of:

  Expand all

  object

  uid: shared_alarm_schema

  Detailed information about the alarm.

  uuid

  string

  Unique identifier of the alarm

  tenant_uuid

  string

  Tenant to which the alarm belongs to

  alarm_reason

  string

  Reason of the alarm, could be one of the following; 'Unknown', 'Alarm condition is violated', 'Alarm condition is adhered', 'The alarm condition does no longer exist', 'The time period for alarm supervision has ended'

  alarm_status

  string

  Status of the alarm, could be one of the following; 'Unknown', 'Alarm', 'Ok'

  last_status_change_time

  string

  Time when the alarm was changed last, UTC in iso8601 format

  alarm_condition_type

  string

  Condition type of the alarm, could be one of the following; 'Unknown', 'The battery of the device is nearly empty', 'Lost external power supply for device', 'Connection timeout, device did not communicated in expected time', 'Sensor is broken', 'Calibration is too old', 'Upper limit', 'Lower limit'

  alarm_severity

  string

  Severity of the alarm, could be one of the following; 'Unknown', 'Alarm', 'Warning'

  alarm_time

  string

  Time when the alarm occurred, UTC in iso8601 format

  alarm_time_local

  string

  Time when the alarm occurred, iso8601 format in the local time of the tenant

  serial_number

  string

  Serial number

  alarm_source_uuid

  string

  Unique identifier of the source that caused the alarm. It depends on the alarm_type; for device system alarm type, alarm_source_uuid is the device_uuid; for sensor system alarm type, alarm_source_uuid is the sensor_uuid; for measurement alarm type, alarm_source_uuid is the sensor_uuid or empty.

  alarm_type

  string

  Type of the alarm, could be one of the following; 'measurement alarm', 'device system alarm', 'sensor system alarm'

  processed_at

  string

  Time when the alarm message got processed, UTC in iso8601 format

  Additional properties are allowed.

  And with:

  Expand all

  object

  uid: additional_schema_for_measurement_alarm

  fields that only exist in measurement alarm type

  alarm_delay

  string

  Delay of the alarm in millisecond.

  alarm_value

  string

  Value of the alarm, various in range depends on its physical properties.

  physical_unit

  string

  Physical unit of the alarm.

  physical_value

  string

  Physical value of the alarm.

  physical_value_extension

  string

  Physical value extension of the alarm.

  Additional properties are allowed.

  Headers

  Expand all

  object

  uid: message_metadata

  content-length

  string

  uid: content_length

  timestamp

  string

  content-type

  string

  message-id

  string

  priority

  string

  subscription

  string

  destination

  string

  uid: destination

  expires

  string

  Additional properties are allowed.

  Examples

  Payload

  {
    "uuid": "b107fe58-6e2d-4f18-bae6-767e2a30c9c7",
    "tenant_uuid": "f9a86182-3b41-4964-1111-149f083b11d6",
    "alarm_reason": "Alarm condition is violated",
    "alarm_status": "Alarm",
    "last_status_change_time": "2023-04-29T01:35:37Z",
    "alarm_condition_type": "Upper limit",
    "alarm_severity": "Warning",
    "alarm_time": "2023-04-29T06:25:00Z",
    "alarm_time_local": "2023-04-29T08:25:00+02:00",
    "serial_number": "56000000",
    "alarm_source_uuid": "f1aa6496-abe8-4920-1111-7ee5f529a321",
    "alarm_type": "measurement alarm",
    "processed_at": "2023-04-29T06:27:25Z",
    "alarm_delay": "300000",
    "alarm_value": "22.015625",
    "physical_unit": "°C",
    "physical_value": "Temperature",
    "physical_value_extension": "Air Temperature"
  }
  

  This example has been generated automatically.

  Headers

  {
    "content-length": "832",
    "timestamp": "1682749648090",
    "content-type": "application/json",
    "message-id": "cb-4d60f416-7083-406c-9476-6d166c21bf72-1-39009-1682707981501-3",
    "priority": "4",
    "subscription": "sub-0",
    "destination": "/queue/username/alarms",
    "expires": "0"
  }
  

  This example has been generated automatically.

• #1system_alarm

  device/sensor system alarm event

  • application/json

  Payload

  Expand all

  object

  uid: shared_alarm_schema

  Detailed information about the alarm.

  uuid

  string

  Unique identifier of the alarm

  tenant_uuid

  string

  Tenant to which the alarm belongs to

  alarm_reason

  string

  Reason of the alarm, could be one of the following; 'Unknown', 'Alarm condition is violated', 'Alarm condition is adhered', 'The alarm condition does no longer exist', 'The time period for alarm supervision has ended'

  alarm_status

  string

  Status of the alarm, could be one of the following; 'Unknown', 'Alarm', 'Ok'

  last_status_change_time

  string

  Time when the alarm was changed last, UTC in iso8601 format

  alarm_condition_type

  string

  Condition type of the alarm, could be one of the following; 'Unknown', 'The battery of the device is nearly empty', 'Lost external power supply for device', 'Connection timeout, device did not communicated in expected time', 'Sensor is broken', 'Calibration is too old', 'Upper limit', 'Lower limit'

  alarm_severity

  string

  Severity of the alarm, could be one of the following; 'Unknown', 'Alarm', 'Warning'

  alarm_time

  string

  Time when the alarm occurred, UTC in iso8601 format

  alarm_time_local

  string

  Time when the alarm occurred, iso8601 format in the local time of the tenant

  serial_number

  string

  Serial number

  alarm_source_uuid

  string

  Unique identifier of the source that caused the alarm. It depends on the alarm_type; for device system alarm type, alarm_source_uuid is the device_uuid; for sensor system alarm type, alarm_source_uuid is the sensor_uuid; for measurement alarm type, alarm_source_uuid is the sensor_uuid or empty.

  alarm_type

  string

  Type of the alarm, could be one of the following; 'measurement alarm', 'device system alarm', 'sensor system alarm'

  processed_at

  string

  Time when the alarm message got processed, UTC in iso8601 format

  Additional properties are allowed.

  Headers

  Expand all

  object

  uid: message_metadata

  content-length

  string

  uid: content_length

  timestamp

  string

  content-type

  string

  message-id

  string

  priority

  string

  subscription

  string

  destination

  string

  uid: destination

  expires

  string

  Additional properties are allowed.

  Examples

  Payload

  {
    "uuid": "b107fe58-6e2d-4f18-bae6-767e2a30c9c7",
    "tenant_uuid": "f9a86182-3b41-4964-1111-149f083b11d6",
    "alarm_reason": "Alarm condition is violated",
    "alarm_status": "Alarm",
    "last_status_change_time": "2023-04-29T01:35:37Z",
    "alarm_condition_type": "Upper limit",
    "alarm_severity": "Warning",
    "alarm_time": "2023-04-29T06:25:00Z",
    "alarm_time_local": "2023-04-29T08:25:00+02:00",
    "serial_number": "56000000",
    "alarm_source_uuid": "f1aa6496-abe8-4920-1111-7ee5f529a321",
    "alarm_type": "measurement alarm",
    "processed_at": "2023-04-29T06:27:25Z"
  }
  

  This example has been generated automatically.

  Headers

  {
    "content-length": "832",
    "timestamp": "1682749648090",
    "content-type": "application/json",
    "message-id": "cb-4d60f416-7083-406c-9476-6d166c21bf72-1-39009-1682707981501-3",
    "priority": "4",
    "subscription": "sub-0",
    "destination": "/queue/username/alarms",
    "expires": "0"
  }
  

  This example has been generated automatically.

Accepts the following message:

{
  "uuid": "8b83c3c4-4a88-45c4-a9ed-87bda598fd8d",
  "device_uuid": "6b492662-002a-4b35-95d4-466264122290",
  "sensor_uuid": "6a081512-efbf-4de1-995f-79959989abce",
  "channel_id": 1913253106,
  "device_serial_no": "54769221",
  "sensor_serial_no": "56000670",
  "tenant_uuid": "f9a86182-3b41-4964-1111-149f083b11d6",
  "timestamp": "2023-04-29T06:25:00Z",
  "timestamp_local": "2023-04-29T08:25:00+02:00",
  "measurement": 21.796875,
  "physical_property_name": "Temperature",
  "physical_unit": "°C",
  "physical_extension": "Air Temperature",
  "processed_at": "2023-04-29T06:27:25Z"
}

{
  "content-length": "832",
  "timestamp": "1682749648090",
  "content-type": "application/json",
  "message-id": "cb-4d60f416-7083-406c-9476-6d166c21bf72-1-39009-1682707981501-3",
  "priority": "4",
  "subscription": "sub-0",
  "destination": "/queue/username/alarms",
  "expires": "0"
}