Zum Hauptinhalt springen

API-Benutzerhandbuch

Vollständiges Benutzerhandbuch für die PlantPulse Java API-Clientbibliothek (plantpulse-api). Über 13 Domänendienste erhalten Sie Zugriff auf sämtliche Stamm- und Betriebsdaten der Plattform — Standorte, Assets, Tags, Alarme, Arbeitsaufträge und mehr.

Merkmale der Bibliothek​

  • Standard-REST — GET/POST/PUT/PATCH/DELETE werden semantisch korrekt eingesetzt
  • Typisierte DTOs — alle Anfragen und Antworten werden automatisch auf *RequestV5- / *ResponseV5-Klassen abgebildet (kein manuelles Parsen von JSONObject nötig)
  • PATCH je Registerkarte — 10 Varianten der Teilaktualisierung für Tag: Alarm, Metadaten, Berechnung, Aggregation usw.
  • 13 Domänendienste — system, site, customer, employee, product, asset, opc, tag, alarm, order, calendar, path, flow
  • Sichere Standardwerte — bei Fehlern wird null oder eine leere Liste zurückgegeben (keine Exceptions)

Für wen ist dieses Handbuch gedacht? Es ist eine vollwertige Referenz für alle, die externe Systeme (MES, ERP, eigene Dashboards usw.) in Java an die PlantPulse Platform anbinden.

Kurzer Überblick​

BereichHinweis
Für den EinstiegLesen Sie in dieser Reihenfolge: 1. Erste Schritte → 2. Regeln für Domänen-IDs → 3. Antwortformat und Fehlerbehandlung.
Wenn Sie eine bestimmte Domäne benötigenSpringen Sie im Inhaltsverzeichnis unten direkt zum jeweiligen Dienst (z. B. Tag, Order).
Wenn Sie REST direkt aufrufenDie vollständige Endpunktliste enthält die Zuordnung von URLs und Methoden.
Wenn Sie Workflow-Beispiele suchenIn der Beispielsammlung finden Sie Ende-zu-Ende-Szenarien.

Kernkonzepte​

  • Einstiegspunkt: new APIClient_V5(proto, host, port, user, token, debug) → connect()
  • 13 Dienste: client.system(), client.site(), client.customer(), client.employee(), client.product(), client.asset(), client.opc(), client.tag(), client.alarm(), client.order(), client.calendar(), client.path(), client.flow()
  • Rückgabe typisierter DTOs: Alle Methoden liefern statt JSONObject typisierte Klassen (SiteResponseV5, TagResponseV5 usw.)
  • Sichere Standardwerte bei Fehlern: create/update/get → null, list → leere Liste, delete/exists → false, count → 0
  • Auslesen von Fehlerantworten: statische Methoden BaseServiceV5.getErrorCode(env), getErrorMessage(env), getHttpStatus(env)
  • Prüfung von Domänen-IDs: SITE_, ASSET_, OPC_/API_, TAG_ — Präfix wird erzwungen (serverseitiger Validator)
  • Basispfad: Alle Aufrufe erfolgen über Endpunkte unterhalb von /api/v5

Inhaltsverzeichnis​

Einstieg und Grundregeln​

  1. Erste Schritte — Client erzeugen und verbinden
  2. Regeln für Domänen-IDs ⭐ Bitte unbedingt zuerst lesen
  3. Antwortformat und Fehlerbehandlung

Infrastruktur- und Modelldomänen​

  1. System-Dienst — Health-Check
  2. Site-Dienst — Standort-(Werks-)Stammdaten
  3. OPC-Dienst — Kanäle zur Datenerfassung
  4. Asset-Dienst — Asset-Hierarchie (Area, Line, Equipment)
  5. Tag-Dienst — Tag-Definition + 10 PATCH-Varianten
  6. Path-Dienst — Abfrage von Asset-Pfaden

Betriebsdomänen​

  1. Alarm-Dienst — Abfrage von Alarm-Ereignissen
  2. Calendar-Dienst — Termine (Inspektion, Stillstand usw.)
  3. Order-Dienst — Arbeitsaufträge + Lebenszyklus

Stammdaten​

  1. Customer-Dienst — Kunden
  2. Employee-Dienst — Mitarbeiter
  3. Product-Dienst — Produkte

Automatisierung​

  1. Flow-Dienst — Abfrage von Flow / Flow Node

Anhang​

  1. Vollständige Endpunktliste — URL-Zuordnung
  2. Beispielsammlung — Ende-zu-Ende-Workflows

Kontakt: webmaster@kopens.com