Alarms
- GET /api/alarms/
Get a list of alarms.
- Query Parameters:
machine (int) – if specified by ID, only alarms from that machine will be returned
day (string) – if specified (in
YYYY-MM-DD
format), only alarms on that date (UTC) will be returned
Example response:
- Returns:
an object mapping alarm IDs to Alarm objects
- PATCH /api/alarms/(int: alarm_id)
Edit an existing alarm.
- Request JSON Object:
notes (string) – a new notes field value
- Parameters:
alarm_id – the ID of the alarm to edit
- Returns:
the modified alarm object
- Status Codes:
404 Not Found – if the alarm doesn’t exist
- DELETE /api/alarms/(int: alarm_id)
Delete an alarm from the database.
- Parameters:
alarm_id – The numeric ID of the alarm to delete.
- Status Codes:
204 No Content – on success
404 Not Found – if the alarm does not exist