API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · alarms

Alarm Schema

Schema-ID
alarm
Collection
alarms
Permissions
  • Lesenalarm_view
  • Anlegenalarm_manage
  • Ändernalarm_manage
  • Löschenalarm_manage
Beziehungen

Felder

Alarm Schema

alarms4 Permissions

ADR 0326 — stateful monitoring alarm (one doc per open dedupKey period), classified by the alarm rule stack.

statusstringerforderlich

Lifecycle: OPEN → ACKNOWLEDGED (in Bearbeitung) → RESOLVED (source sent CLEAR) | CLOSED (manual or auto_close action).

OPENACKNOWLEDGEDRESOLVEDCLOSED
read-only
isOpenbooleanerforderlich

Computed: true while status is OPEN or ACKNOWLEDGED. Exists solely for the unique partial index (one open alarm per dedupKey) — always derive from status, never set independently.

read-only
severitystringerforderlich

Display severity from the FIRST matching rule; fallback: severityHint mapping (critical→error) when no rule matched.

infowarningerror
read-only
canonicalSeveritystringoptional

Provider-mapped 4-level severity of the first RAISE (RmmSeverity). Kept alongside the 3-level display severity because ticket-priority policies are 4-level — the seeded default rule maps priorities from THIS field (fixed-policy parity).

infowarningerrorcriticalnull
Default: nullread-onlynullable
dedupKeystringerforderlich

Provider-scoped identity (ADR 0244) — passed through, never recomputed.

1–500 Zeichenread-only
providerstringerforderlich

RMM provider id (octoja|riverbird|…).

max 40 Zeichenread-only
connectionIdstringoptional

integration_config the events came from.

PatternDefault: nullread-onlynullable
errorTypestringoptional

Check name/category ("Fehlerart") — snapshot from the first RAISE.

max 500 ZeichenDefault: nullread-onlynullable
checkTypestringoptional

Normalized check type (RMM_CHECK_TYPES catalog value), null when unknown.

max 40 ZeichenDefault: nullread-onlynullable
messagestringoptional

Human-readable check output — updated on UPDATE events.

max 20000 ZeichenDefault: nullread-onlynullable
deviceNamestringoptional
max 500 ZeichenDefault: nullread-onlynullable
deviceCategorystringoptional

Normalized device category (RMM_DEVICE_CATEGORIES value).

max 40 ZeichenDefault: nullread-onlynullable
siteNamestringoptional
max 500 ZeichenDefault: nullread-onlynullable
customerNamestringoptional
max 500 ZeichenDefault: nullread-onlynullable
partyIdstringoptional
PatternDefault: nullread-onlynullable
rmmDeviceIdstringoptional
PatternDefault: nullread-onlynullable
assetIdstringoptional

CMDB asset of the device — snapshot of rmm_device.assetId at alarm creation; null = no match ("ohne Asset" marker in the UI).

PatternDefault: nullread-onlynullable
ticketIdstringoptional

Ticket created/attached by a create_ticket action.

PatternDefault: nullread-onlynullable
matchedRuleIdsuuid[]optional

All rules that matched (evaluation transparency in the UI).

Default: []read-only
suppressedByExceptionbooleanoptional

A rule matched but its exception suppressed all actions.

Default: falseread-only
pinnedbooleanoptional

OR over the matching rules — a pinned alarm cannot be hidden.

Default: falseread-only
hiddenByuuid[]optional

Users who hid this alarm from their board (only when not pinned).

Default: []read-only
acknowledgedBystringoptional
PatternDefault: nullread-onlynullable
acknowledgedAtdatetimeoptional
Default: nullread-onlynullable
firstOccurredAtdatetimeoptional
Default: nullread-onlynullable
lastEventAtdatetimeoptional
Default: nullread-onlynullable
resolvedAtdatetimeoptional
Default: nullread-onlynullable
eventCountintegeroptional
≥ 0Default: 1read-only
scheduledActionJobIdsstring[]optional

Pending BullMQ action jobIds — best-effort cancel bookkeeping on CLEAR/ack.

Default: []read-only
executedActionKeysstring[]optional

Idempotency keys of actions that already fired. The authoritative dedup — BullMQ jobId dedup ends at removeOnComplete.

Default: []read-only

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/alarms — Liste, paginiert + filterbar
  • GET /api/v1/alarms/<id> — Einzelne Entity
  • POST /api/v1/alarms — Anlegen
  • PATCH /api/v1/alarms/<id> — Teil-Update
  • DELETE /api/v1/alarms/<id> — Soft-Delete
  • GET /api/v1/alarms/<id>/timeline — Audit + Aktivitäten

Suche