Alert Rules

The task of alert rules is to determine which noncompliance a camera will monitor and in which areas it can alert.

Export alert rules

GET/alert_rules/export

Arguments

Query String Parameters

• format Enum optional
  • CSV (default)
  • JSON
  • JSONL

Returns

Returns list of alert rule objects for given format.

Field	Type	Description
id	UUID	Unique identifier for alert rule
name	Enum	Alert rule name ex: LINE_OF_FIRE, APRON
cameraId	UUID	Unique identifier for a camera in which alert rule is created from
severity	Enum	Severity type ex: HIGH, MEDIUM & LOW
status	Enum	The field shows that rule status ex: ACTIVE, INACTIVE
observation	Bool	The field shows that an alert is created for just observation or not
createdAt	DateTime	The field shows creation time of the alert rule

Csv

id,name,cameraId,severity,status,observation,createdAt
4b8f669d-1e1c-438e-8488-8d6d0c3ddde6,HELMET,27fd644b-23fa-426b-a93c-163a3328993f,MEDIUM,ACTIVE,false,2022-10-04T20:47:00Z
81e83ddd-8795-43d5-a1e3-91372d339c4e,STATIC_DELIMITATION_AREA,27fd644b-23fa-426b-a93c-163a3328993f,LOW,ACTIVE,false,2022-11-05T20:47:00Z

Json

[
  {
    "id": "4b8f669d-1e1c-438e-8488-8d6d0c3ddde6",
    "name": "HELMET",
    "cameraId": "27fd644b-23fa-426b-a93c-163a3328993f",
    "severity": "MEDIUM",
    "status": "ACTIVE",
    "observation": false,
    "createdAt": "2022-10-04T20:47:00Z"
  },
  {
    "id": "81e83ddd-8795-43d5-a1e3-91372d339c4e",
    "name": "STATIC_DELIMITATION_AREA",
    "cameraId": "27fd644b-23fa-426b-a93c-163a3328993f",
    "severity": "LOW",
    "status": "ACTIVE",
    "observation": false,
    "createdAt": "2022-11-05T20:47:00Z"
  }
]

Json Lines

{"id":"4b8f669d-1e1c-438e-8488-8d6d0c3ddde6","name":"HELMET","cameraId":"27fd644b-23fa-426b-a93c-163a3328993f","severity":"MEDIUM","status":"ACTIVE","observation":false,"createdAt": "2022-10-04T20:47:00Z"}
{"id":"81e83ddd-8795-43d5-a1e3-91372d339c4e","name":"STATIC_DELIMITATION_AREA","cameraId":"27fd644b-23fa-426b-a93c-163a3328993f","severity":"LOW","status":"ACTIVE","observation":false,"createdAt": "2022-11-05T20:47:00Z"}

---