Zurück zum Hilfecenter

Schnittstelle: Rezepte

Rezept: Prüfergebnisse aus der Instandhaltung melden

Ergebnisse aus der Wartungssoftware als Barrierenprüfung in elyph eintragen.

Für wen

IT und Instandhaltung.

Voraussetzungen

Schlüssel mit `barriers:read` und `barrier_checks:write`

Schritt für Schritt

  1. 1

    Barrieren zuordnen

    Einmalig die Barrieren laden und in Ihrem System hinterlegen: `reference` als sprechendes Kürzel, die interne Kennung für die Meldung.

    curl
    curl -sS "https://api.elyph.io/v1/barriers?kind=technisch&limit=200" \
  -H "Authorization: Bearer $ELYPH_API_KEY"
  2. 2

    Ergebnis melden

    Nach jeder Wartung ein Prüfergebnis senden. `result` ist `passed`, `failed` oder `partial`.

    Python
    import os, requests

key = os.environ["ELYPH_API_KEY"]

def report(barrier_id, passed, findings, performed_at, method="Funktionstest"):
    response = requests.post(
        "https://api.elyph.io/v1/barrier-checks",
        headers={"Authorization": f"Bearer {key}", "Content-Type": "application/json"},
        json={
            "barrier_id": barrier_id,
            "result": "passed" if passed else "failed",
            "performed_at": performed_at,
            "method": method,
            "findings": findings,
        },
        timeout=30,
    )
    if response.status_code == 422:
        raise ValueError(response.json()["error"]["message"])
    response.raise_for_status()
    return response.json()["data"]["id"]
  3. 3

    Fehlschläge weiterverfolgen

    Ein nicht bestandenes Ergebnis löst das Ereignis `barrier_check.failed` aus. Damit lässt sich sofort eine Sofortmaßnahme anstoßen.

  4. 4

    Nachweis prüfen

    In elyph erscheint die Prüfung in der Historie der Barriere, mit dem Namen des Zugangs als Urheber.

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.

GET https://api.elyph.io/v1/barriers?limit=10

Art der Barriere exakt wie im Feld `kind`.

Katalogkategorie exakt wie im Feld `category`.

Kennung des Standorts (UUID der Organisationseinheit).

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

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

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

curl
curl -sS "https://api.elyph.io/v1/barriers?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": "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

Prüfnachweise entstehen dort, wo gearbeitet wird, und stehen in elyph revisionssicher zur Verfügung.

Häufige Stolpersteine

  • Prüfungen mehrfach senden: Merken Sie sich die zurückgegebene `id` je Wartungsauftrag.
  • Barrieren einer fremden Organisation melden: Der Aufruf ergibt 404, weil die Barriere nicht zum Mandanten gehört.

Verwandte Artikel