Referenz: Risiken (/v1/risk-scenarios)

Szenarien mit Brutto- und Nettobewertung. Alle Felder, Filter, Rechte und Fehler dieser Ressource.

Für wen

Entwicklerinnen und Entwickler, die elyph anbinden.

Voraussetzungen

Schlüssel mit dem Recht risk_scenarios:read Grundlagen aus „Erste Anfrage an die elyph API“

Schritt für Schritt

1
Liste abrufen
GET https://api.elyph.io/v1/risk-scenarios liefert die Objekte des Mandanten, sortiert nach letzter Änderung. Erforderliches Recht: risk_scenarios:read.
curl
curl -sS "https://api.elyph.io/v1/risk-scenarios?limit=50&assessment=9c1e%E2%80%A6" \ -H "Authorization: Bearer $ELYPH_API_KEY"

Antwort lesen

Die Antwort enthält `data` mit den Objekten, `page.next` als Fortsetzungsmarke und `rate` mit dem verbleibenden Abfragekontingent.

Antwort

{
  "data": [
    {
      "reference": "RIS-2026-041",
      "title": "Eingriff in laufende Presse",
      "assessment": {
        "reference": "GBU-2026-014"
      },
      "cause": "Störung wird ohne Stillsetzen behoben",
      "event": "Werkzeug schließt bei Eingriff",
      "consequence": "Quetschung der Hand",
      "gross": {
        "probability": 4,
        "severity": 5,
        "score": 20
      },
      "net": {
        "probability": 2,
        "severity": 5,
        "score": 10
      },
      "tolerance_decision": "nicht tragbar — Maßnahmen laufen",
      "updated_at": "2026-01-27T15:02:10Z"
    }
  ],
  "page": {
    "next": null,
    "limit": 50
  },
  "rate": {
    "limit": 120,
    "remaining": 118,
    "reset_at": "2026-02-01T10:31:00Z"
  }
}

3
Filter setzen
Verfügbare Filter: `assessment` — Kennung der Beurteilung (UUID), zu der die Szenarien gehören. `updated_since` — Nur Objekte, die seit diesem Zeitpunkt geändert wurden (ISO 8601). Grundlage jeder Synchronisation. `limit` — Anzahl der Objekte je Seite, 1 bis 200. Standard 50. `page` — Fortsetzungsmarke aus `page.next` der vorherigen Antwort. Keine Seitenzahl. Mehrere Filter werden mit `&` verbunden und wirken zusammen.
4
Einzelnes Objekt holen
Der Pfad /v1/risk-scenarios/{Kennung} liefert genau ein Objekt. Kennung ist `reference`, etwa `RIS-2026-041`. Unbekannte Kennungen ergeben 404 `not_found`.
curl
curl -sS "https://api.elyph.io/v1/risk-scenarios/{kennung}" \ -H "Authorization: Bearer $ELYPH_API_KEY"

Felder der Antwort

Feld	Typ	Bedeutung
reference	string	Nummer des Szenarios.
title	string	Bezeichnung des Szenarios.
assessment.reference	string \| null	Beurteilung, zu der das Szenario gehört.
cause	string \| null	Ursache im Bow-Tie.
event	string \| null	Auslösendes Ereignis.
consequence	string \| null	Folge im Bow-Tie.
gross.probability	number	Eintrittswahrscheinlichkeit ohne Barrieren.
gross.severity	number	Schadensschwere ohne Barrieren.
gross.score	number	Bruttorisiko = Wahrscheinlichkeit × Schwere.
net.probability	number \| null	Wahrscheinlichkeit mit wirksamen Barrieren.
net.severity	number \| null	Schwere mit wirksamen Barrieren.
net.score	number \| null	Nettorisiko nach Barrierenwirkung.
tolerance_decision	string \| null	Entscheidung zur Tragbarkeit des Restrisikos.
updated_at	string (ISO 8601)	Letzte Änderung. Sortierfeld der Liste und Grundlage für `updated_since`.

Filter

Parameter	Beschreibung	Beispiel
assessment	Kennung der Beurteilung (UUID), zu der die Szenarien gehören.	assessment=9c1e…
updated_since	Nur Objekte, die seit diesem Zeitpunkt geändert wurden (ISO 8601). Grundlage jeder Synchronisation.	updated_since=2026-01-01T00:00:00Z
limit	Anzahl der Objekte je Seite, 1 bis 200. Standard 50.	limit=100
page	Fortsetzungsmarke aus `page.next` der vorherigen Antwort. Keine Seitenzahl.	page=eyJ1IjoiMjAy…

Rechte und Methoden

Angabe	Wert
Pfad	/v1/risk-scenarios
Methoden	GET
Rechte	risk_scenarios:read
Kennung	`reference`, etwa `RIS-2026-041`

API-Konsole

Anfrage zusammenstellen, Code kopieren und — angemeldet und mit eigenem Schlüssel — wirklich ausführen. Die Konsole führt ausschließlich lesende Aufrufe aus.

Ressource

Adresse

GET https://api.elyph.io/v1/risk-scenarios?limit=10

assessment

Kennung der Beurteilung (UUID), zu der die Szenarien gehören.

updated_since

Nur Objekte, die seit diesem Zeitpunkt geändert wurden (ISO 8601). Grundlage jeder Synchronisation.

limit

Anzahl der Objekte je Seite, 1 bis 200. Standard 50.

page

Fortsetzungsmarke aus `page.next` der vorherigen Antwort. Keine Seitenzahl.

curl

curl -sS "https://api.elyph.io/v1/risk-scenarios?limit=10" \
  -H "Authorization: Bearer $ELYPH_API_KEY"

Echttest

Nach der Anmeldung führen Sie dieselbe Anfrage hier mit Ihrem eigenen Schlüssel aus. So sieht eine echte Antwort aus:

Beispielantwort

{
  "data": [
    {
      "reference": "RIS-2026-041",
      "title": "Eingriff in laufende Presse",
      "assessment": {
        "reference": "GBU-2026-014"
      },
      "cause": "Störung wird ohne Stillsetzen behoben",
      "event": "Werkzeug schließt bei Eingriff",
      "consequence": "Quetschung der Hand",
      "gross": {
        "probability": 4,
        "severity": 5,
        "score": 20
      },
      "net": {
        "probability": 2,
        "severity": 5,
        "score": 10
      },
      "tolerance_decision": "nicht tragbar — Maßnahmen laufen",
      "updated_at": "2026-01-27T15:02:10Z"
    }
  ],
  "page": {
    "next": null,
    "limit": 10
  },
  "rate": {
    "limit": 120,
    "remaining": 118,
    "reset_at": "2026-02-01T10:31:00Z"
  }
}

Ergebnis

Sie können risiken zuverlässig lesen, filtern und mit Ihrem System abgleichen.

Häufige Stolpersteine

Interne UUIDs statt der fachlichen Kennung speichern: Verwenden Sie `reference`, etwa `RIS-2026-041` als stabile Verknüpfung.
Alle Daten bei jedem Lauf neu laden: Mit `updated_since` holen Sie nur Änderungen.

Hintergrund

Die Ressource ist streng auf den Mandanten des Schlüssels begrenzt. Ist der Zugang auf Standorte eingeschränkt, liefert die Liste nur Objekte dieser Standorte. Jede Anfrage wird mit Zeitpunkt, Pfad, Status und Trefferzahl protokolliert und ist in der Verwaltung einsehbar.