List alert types

GET /api/alert_types

Allows you to get the full list of alert types that exist in the system and their definition.

Responses

200

OK
Hide response attribute Show response attribute object
- data array[object]
  
  List of alert types
  
  Hide data attributes Show data attributes object
  
  base_tag string
  
  The name of the tag emitted by the PLC to watch for changes on.
  
  condition_over number
  
  A second conditioner used in different ways depending on the alert type.
  
  extra_tag string
  
  A secondary tag to use in different ways depending on the alert type.
  
  id string
  
  The id of the alert type.
  
  name string
  
  The human readable name given to the alert.
  
  threshold number
  
  A threshold used in different ways depending on the alert type.
  
  type string
  
  The kind of alert type. time | tag | tag_threshold | value_threshold.
401

Unauthorized
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code

GET /api/alert_types

curl \
 -X GET http://localhost:4000/api/alert_types

Response examples (200)

{
  "data": [
    {
      "id": "57df5898-0c40-4176-9dd4-e0c96c6c810e",
      "name": "Flame Guard Alarm",
      "type": "time",
      "base_tag": "FlameGuardAlarm_count",
      "extra_tag": "i_xFlameAlarm",
      "threshold": 5,
      "condition_over": 5
    }
  ]
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}