alarming

Alarms raised by the condition monitoring - listing, updating, open alarm locations.

📄️Returns a page of alarms

Returns one page of the alarm results, filtered and sorted by the server. The alarm table grows without bound - every sweep of the condition monitoring appends to it - so there is deliberately no way to ask for all of it: the size of the answer depends on the requested page size and not on the size of the table.

📄️Update an alarm - a status change, a note, or both

Records a status transition as an entry in the alarm's history. An optional note text can be included on that same entry, and a note-only entry (no status change) is also accepted as long as the new status matches the current one. Returns the stored alarm with its complete history, so a caller does not have to read the alarm back to show what was recorded - the entry it contains is the stored one, with the user of the JWT, the server clock and its id. A call that neither changes the status nor carries a note records nothing and returns the alarm unchanged. Responds 404 if the alarm does not exist.

📄️Archive a completed alarm

Marks a completed alarm as archived and records when, by whom and - optionally - why, on the alarm and as an entry of its history (archiveAction ARCHIVED, the reason as its content). An archived alarm keeps its status, severity and completion state; the flag is its own and the list leaves such alarms out unless asked for them (archiveFilter of getAllAlarms). Returns the stored alarm.

📄️Take an alarm out of the archive

Removes the archive marker with its time, user, reason and period, whoever archived the alarm and whenever - an administrator's decision, which is why it needs a comment. What the marker said is not lost: the archiving stays in the alarm's history, and this call adds an entry of its own (archiveAction UNARCHIVED, the comment as its content). Nothing else resets the flag: neither a status change nor anything the condition monitoring does to the alarm touches it, and the automatic archiving leaves an alarm alone once it has been taken out of the archive. An alarm that is not archived is left as it is and returned without a new entry. Returns the stored alarm. Responds 400 if the comment is missing or blank, 404 if the alarm does not exist.

📄️Where the open alarms sit in the tree

Returns every open alarm with the node it was measured on and that node's ancestors. The explorer builds its per-node indicator from this: the state of a node is the highest criticality and the number of open alarms in its subtree (RG-2), aggregated by the client.