RESTful-API in einer benutzerdefinierten Anwendung nutzen

Die vom REST-Plugin zur Verfügung gestellte REST-API bietet die Möglichkeit, Anforderungen an das Bildverarbeitungssystem zu senden und Informationen vom Bildverarbeitungssystem abzufragen. Dies erfolgt über HTTP-Endpunkte, die aus einer vordefinierten URL (Basis‑URL) und einer HTTP-Methode bestehen. Sie können eine für den jeweiligen Anwendungsfall angepasste Anwendung erstellen und Anforderungen an die verfügbaren Endpunkte senden, um Informationen vom Bildverarbeitungssystem abzufragen und das Bildverarbeitungssystem durch Auslösen von Aktionen zu steuern.

Die REST-API unterstützt zwei verschiedene HTTP-Methoden: GET und POST. GET-Methoden werden zum Abfragen von Informationen vom Bildverarbeitungssystem verwendet, um beispielsweise eine Liste der verfügbaren Rezepte oder die Ergebnisse einer Ausführung abzurufen. POST-Methoden werden zum Auslösen einer bestimmten Aktion verwendet, z. B. Laden eines Rezepts oder Starten einer Ausführung.

Im folgenden Abschnitt wird beschrieben, welche Endpunkte von der REST-API bereitgestellt werden und wofür die einzelnen Endpunkte verwendet werden können. Sie können für die folgenden Zwecke verwendet werden:

• Systemstatus abrufen und Aktionen an das Bildverarbeitungssystem senden.
• Rezepte laden und entladen.
• Ausführung von Jobs starten (Einzelausführung oder kontinuierliche Ausführung).
• Informationen zu Rezepten, aktiven Jobs, Ereignissen und Fehlern abrufen.
• Ergebnisse abrufen.

Verfügbare Endpunkte

Die folgende Tabelle enthält eine Übersicht über die verfügbaren Endpunkte der REST-API und somit eine Übersicht über die API-Speichersemantik der Ressourcen.

URI	HTTP-Methode	Beschreibung
/state_machine	GET	Gibt den aktuellen Status des Systems zurück.
/state_machine/actions	POST	Sendet eine Aktion an das Bildverarbeitungssystem.
/state_machine/actions/{action_id}/status	GET	Gibt den Status der angegebenen Aktion zurück.
/recipes	GET	Gibt eine Liste der verfügbaren Rezepte zurück.
/recipes/actions	POST	Sendet eine Aktion für ein bestimmtes Rezept.
/recipes/actions/{action_id}/status	GET	Gibt den Status der angegebenen Aktion für ein bestimmtes Rezept zurück.
/jobs	GET	Gibt eine Liste aller bekannten Jobs in umgekehrter chronologischer Reihenfolge zurück.
/jobs/{job_id}	GET	Gibt Informationen zu einem konkreten Job für ein bestimmtes Rezept zurück.
/recipes/{recipe_id}/jobs	GET	Gibt eine Liste aller für ein bestimmtes Rezept gestarteten Jobs in umgekehrter chronologischer Reihenfolge zurück.
/events	GET	Gibt eine Liste aller Ereignisse in umgekehrter chronologischer Reihenfolge zurück.
/events/{event_id}	GET	Gibt Informationen zu einem bestimmten Ereignis zurück.
/results	GET	Gibt eine Liste der Ergebnisse in umgekehrter chronologischer Reihenfolge zurück.
/recipes/{recipe_id}/results	GET	Gibt eine Liste der Ergebnisse für ein bestimmtes Rezept in umgekehrter chronologischer Reihenfolge zurück.
/jobs/{job_id}/results	GET	Gibt eine Liste der Ergebnisse für einen Job in umgekehrter chronologischer Reihenfolge zurück.
/errors	GET	Gibt eine Liste der Fehler in umgekehrter chronologischer Reihenfolge zurück.
/errors/{error_id}	GET	Gibt Fehlerinformationen für eine bestimmte Fehler-ID zurück.

Weitere Informationen zur REST-API und den verfügbaren Endpunkten finden Sie in der Dokumentation der REST-API, die in der integrierten Webanwendung über den Menüeintrag „API Docs“ aufgerufen werden kann.