Workflow {Rest:API} Beschreibung / v1.0 Rev 28 (Workflow v1.19.0) / 2025-02-10
1. Einleitung
Die Workflow API bietet eine Schnittstelle zu den Funktionen des Workflows, wie z.B. das Anlegen von Artikeln, Aufträgen und Produktionsaufträgen. Es bietet auch den Abruf der verwendeten Materialien und Materialkategorien sowie der zugehörigen Farbstrategien. Statusinformationen können über Callback-URLs (Abonnements) an verbundene ERP/MIS-Systeme übergeben werden.
Die API ist ein REST (Representational State Transfer) Service. Als Application Layer Protokolle werden HTTP und HTTPS verwendet. REST vereinheitlicht die Schnittstelle zwischen den Systemen zu einem überschaubaren und standardisierten Satz von Aufrufen mit unterschiedlichen Funktionen, die in diesem Dokument ausführlich erläutert werden.
Bitte beachten Sie, dass die detaillierten Ausführungen und Beschreibungen in englischer Sprache dokumentiert sind, da auch die Antworten der REST Schnittstelle (Status, Fehlermeldungen und dergleichen in englischer Sprache vorliegen).
Trotz intensiver Tests und aufmerksamer Recherche garantieren wir keine vollständige Korrektheit der Dokumentation. Da auch die Schnittstelle laufend erweitert wird, wird sich auch der Umfang der Dokumentation ständig ändern. Bitte beachten Sie daher stets Veröffentlichungsdatum und Revisionsnummer sowie die Angabe zur Kompatibilität der jeweiligen Funktion.
2. Übersicht
2.1. Versionsinformation
Version: 1.0
2.2. URI Schema
| Parameter | Wert |
|---|---|
| Host | xxx.xxx.xxx.xxx:8081 |
| BasePath | /pms |
| Schema | HTTP |
| Parameter | Wert |
|---|---|
| Host | xxx.xxx.xxx.xxx |
| BasePath | /pms |
| Schema | HTTPS |
HTTPS wird über einen Proxy-Dienst auf der Workflow-Workstation/dem Server ausgeführt. Für die Einrichtung ist ein gültiges Zertifikat erforderlich. Kontaktieren Sie uns für weitere Details.
2.3. Verfügbarkeit von Funktionen
Der Workflow ist in verschiedenen Versionen erhältlich. Je nach Lizenzierung und Funktionsumfang unterscheidet sich auch die Verfügbarkeit für API-Requests.
2.4. Online Dokumentation
Die verfügbaren Endpoints, Beschreibungen der Funktionen, sowie Beispiele erhalten Sie in der englischen Fassung des Benutzerhandbuches.