Referenz: Barrieren (/v1/barriers)

Schutzbarrieren mit Art, Verantwortung und Prüfrhythmus. Alle Felder, Filter, Rechte und Fehler dieser Ressource.

Für wen

Entwicklerinnen und Entwickler, die elyph anbinden.

Voraussetzungen

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

Schritt für Schritt

1
Liste abrufen
GET https://api.elyph.io/v1/barriers liefert die Objekte des Mandanten, sortiert nach letzter Änderung. Erforderliches Recht: barriers:read.
curl
curl -sS "https://api.elyph.io/v1/barriers?limit=50&kind=technisch" \ -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": "BAR-0207",
      "name": "Zweihandschaltung Presse 3",
      "kind": "technisch",
      "category": "Schutzeinrichtung",
      "effectiveness": 4,
      "critical": true,
      "owner": {
        "name": "Sabine Kern",
        "email": "sabine.kern@example.com"
      },
      "site": {
        "reference": "WN",
        "name": "Werk Nord"
      },
      "review": {
        "interval_months": 12,
        "last_at": "2025-11-04",
        "next_at": "2026-11-04"
      },
      "standard_reference": "DIN EN ISO 13851",
      "active": true,
      "updated_at": "2025-11-04T10:44:00Z"
    }
  ],
  "page": {
    "next": null,
    "limit": 50
  },
  "rate": {
    "limit": 120,
    "remaining": 118,
    "reset_at": "2026-02-01T10:31:00Z"
  }
}

3
Filter setzen
Verfügbare Filter: `kind` — Art der Barriere exakt wie im Feld `kind`. `category` — Katalogkategorie exakt wie im Feld `category`. `site` — Kennung des Standorts (UUID der Organisationseinheit). `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/barriers/{Kennung} liefert genau ein Objekt. Kennung ist `reference` (Kurzzeichen der Barriere). Unbekannte Kennungen ergeben 404 `not_found`.
curl
curl -sS "https://api.elyph.io/v1/barriers/{kennung}" \ -H "Authorization: Bearer $ELYPH_API_KEY"

Felder der Antwort

Feld	Typ	Bedeutung
reference	string	Kurzzeichen der Barriere.
name	string	Bezeichnung der Barriere.
kind	string	Art: `technisch`, `organisatorisch`, `personenbezogen`.
category	string \| null	Einordnung, etwa `Schutzeinrichtung`, `Unterweisung`.
effectiveness	number \| null	Bewertete Schutzwirkung (1–5).
critical	boolean	Ob die Barriere als kritisch geführt wird.
owner.name	string \| null	Name der verantwortlichen Person.
owner.email	string \| null	E-Mail der verantwortlichen Person.
site.reference	string \| null	Kurzzeichen des Standorts.
site.name	string \| null	Name des Standorts.
review.interval_months	number \| null	Prüfabstand in Monaten.
review.last_at	string \| null	Letzte Prüfung.
review.next_at	string \| null	Nächste fällige Prüfung.
standard_reference	string \| null	Norm- oder Regelwerksbezug.
active	boolean	Ob die Barriere in Betrieb ist.
updated_at	string (ISO 8601)	Letzte Änderung. Sortierfeld der Liste und Grundlage für `updated_since`.

Filter

Parameter	Beschreibung	Beispiel
kind	Art der Barriere exakt wie im Feld `kind`.	kind=technisch
category	Katalogkategorie exakt wie im Feld `category`.	category=mechanisch
site	Kennung des Standorts (UUID der Organisationseinheit).	site=4f4c…
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/barriers
Methoden	GET
Rechte	barriers:read
Kennung	`reference` (Kurzzeichen der Barriere)

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/barriers?limit=10

kind

Art der Barriere exakt wie im Feld `kind`.

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": "BAR-0207",
      "name": "Zweihandschaltung Presse 3",
      "kind": "technisch",
      "category": "Schutzeinrichtung",
      "effectiveness": 4,
      "critical": true,
      "owner": {
        "name": "Sabine Kern",
        "email": "sabine.kern@example.com"
      },
      "site": {
        "reference": "WN",
        "name": "Werk Nord"
      },
      "review": {
        "interval_months": 12,
        "last_at": "2025-11-04",
        "next_at": "2026-11-04"
      },
      "standard_reference": "DIN EN ISO 13851",
      "active": true,
      "updated_at": "2025-11-04T10:44:00Z"
    }
  ],
  "page": {
    "next": null,
    "limit": 10
  },
  "rate": {
    "limit": 120,
    "remaining": 118,
    "reset_at": "2026-02-01T10:31:00Z"
  }
}

Ergebnis

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

Häufige Stolpersteine

Interne UUIDs statt der fachlichen Kennung speichern: Verwenden Sie `reference` (Kurzzeichen der Barriere) 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.