Transaktions- und Protokollendpunkte
Ihr Leitfaden zur V5-Integration!
Einführung
Zusätzlich zu den Export-Endpunkten, die wir bisher in unseren V5-Integrationsleitfäden vorgestellt haben, bietet die V5-API auch mehrere Transaktions-Endpunkte, mit denen Systemereignis-Deskriptoren /Protokolle an ein externes ERP-System zurückgegeben werden können.
Inhaltsverzeichnis
1. Systemprotokoll-Endpunkte
Generische Endpunkte können verwendet werden, um eine breite Palette von Deskriptoren über verschiedene Module hinweg zurückzugeben.
Diese Endpunkte geben komplexere Daten zurück als transaktionale/generische Endpunkte und enthalten häufig mehrere Sätze verschachtelter Daten im Zusammenhang mit Deskriptorereignissen. Dies ist zwar in dem Sinne nützlich, dass die richtigen Daten zurückgegeben werden, diese Endpunkte müssen jedoch häufig gefiltert werden, um die zurückgegebenen Daten optimal zu nutzen.
Was das für die V5-API ist, können wir unten sehen:
1.1. Systemprotokolle
Endpunkt/URI –
http://host:port/V5-API/api/integrate/export/system_logs
Dieser Endpunkt liefert eine JSON-Datei zurück, die alle Systemereignisbeschreibungen und die zugehörigen Daten enthält. Wenn wir diesen Endpunkt aufrufen, erhalten wir eine Antwort, die etwa so aussieht :
Wir können hier also sehen, dass wir, obwohl wir am unteren Rand dieses Bildes den Deskriptor „CONSUMED“ für einige Saffron Threads erhalten, die für einen Stapel verwendet werden, auch viele zusätzliche verschachtelte Daten erhalten, wie z. B. eine vollständige Klassenrückgabe für Lieferant und Standort, den wir hier sehen können.
In Ihrem ERP können Filter eingerichtet werden, um gezielt die Daten auszuwählen, die Sie sehen möchten.
Diese Beispieldatei kann hier heruntergeladen werden.
Nützlich zum:
1.2. Systemprotokoll
Endpunkt/URI –
http://host:port/V5-API/api/integrate/export/system_log/{id}
Dieser Endpunkt liefert eine JSON-Datei, die ähnlich wie der oben beschriebene Export der Systemprotokolle strukturiert ist. Hier kann jedoch eine einzelne Protokoll-ID angegeben werden, um die zugehörigen Informationen abzurufen. Dies ist hilfreich, wenn man sich auf ein bestimmtes Ereignis oder einen bestimmten Deskriptor konzentrieren möchte.
Ein Beispiel für diesen Dateityp kann hier heruntergeladen werden.
Nützlich zum:
1.3. Anpassungssystemprotokolle
Endpunkt/URI –
http://host:port/V5-API/api/integrate/export/adjustment_logs
Dieser Endpunkt liefert eine JSON-Datei mit einer Liste von Systemprotokollereignissen, die den Deskriptor „ADJUSTMENT“ enthalten . Dadurch werden die Ergebnisse im Vergleich zu den oben dargestellten Systemprotokollen auf Einträge beschränkt, die ausschließlich diesen Deskriptor enthalten. Dies stellt sicher, dass das ERP-System je nach Bedarf relevantere Daten verarbeiten kann.
Ein Beispiel für diesen Dateityp kann hier heruntergeladen werden.
Nützlich zum:
1.4. Verbrauchte/produzierte Systemprotokolle:
Endpunkt/URI –
http://host:port/V5-API/api/integrate/export/system_logs_cp
Dieser Endpunkt liefert eine JSON-Datei mit einer Liste von Systemprotokollereignissen, die entweder den Deskriptor „CONSUMED“ oder „PRODUCED“ enthalten. Dadurch werden die Ergebnisse der oben beschriebenen Systemprotokolle auf Einträge mit diesen Deskriptoren beschränkt. Diese Protokolle beziehen sich auf den Hauptprozess der Stapelverarbeitung, insbesondere auf die Reduzierung und Produktion von Lagerbeständen. Dies stellt sicher, dass das ERP-System je nach Bedarf relevantere Daten verarbeiten kann.
Ein Beispiel für diesen Dateityp kann hier heruntergeladen werden.
Nützlich zum:
1.5. Nicht verbrauchte/produzierte Systemprotokolle:
Endpunkt/URI –
http://host:port/V5-API/api/integrate/export/system_logs_noncp
Dieser Endpunkt fungiert im Prinzip als Umkehrung des oben genannten Endpunkts „Verbrauchte/Erzeugte Systemprotokolle“ und gibt eine JSON-Datei zurück, die Systemprotokolle mit allen Deskriptoren außer „CONSUMED“ oder „PRODUCED“ auflistet.
Nützlich zum:
1.6. Nutzungsprotokolle
Endpunkt/URI –
http://host:port/V5-API/api/integrate/export/batch_system_logs
Dieser Endpunkt liefert eine JSON-Datei mit einer Liste von Systemprotokollereignissen, die sich auf die Stapelverarbeitung beziehen. Dadurch werden die zurückgegebenen Systemprotokolle, wie oben beschrieben, auf Einträge mit Beschreibungen wie „COLLATED“, „BATCH SUSPENDED“ usw. (sowie „CONSUMED“ und „PRODUCED“) beschränkt. Dies stellt sicher, dass das ERP-System je nach Bedarf relevantere Daten verarbeiten kann.
Ein Beispiel für diesen Dateityp kann hier heruntergeladen werden.
Nützlich zum:
1.7. Nutzungsprotokolle (Filterdatum)
Endpunkt/URI –
http://host:port/V5-API/api/integrate/export/batch_system_logs/filterFrom/{filterDate}
Dieser Endpunkt gibt die gleichen Informationen zurück wie „Nutzungsprotokolle“ oben, ermöglicht jedoch bei Bedarf einen Filter nach Datum (Epochenzeitstempel), um die Ergebnisse einzugrenzen.
Nützlich zum:
1.8. Jobprotokolle
2. Transaktionale/generische Endpunkte
Transaktionale Endpunkte liefern vereinfachte Informationen zu Deskriptorereignissen , die sich genauer auf die Bestandsverwaltung verschiedener Module beziehen. Im Gegensatz zu den oben beschriebenen generischen Endpunkten, die vielfältige, verschachtelte Daten bereitstellen, liefern diese Endpunkte vereinfachte Informationen ohne verschachtelte Daten.
Wie das aussehen würde, können wir in unseren Beispielen unten sehen:
2.1. Anpassungstransaktionen
Endpunkt/URI –
http://host:port/V5-API/api/integrate/export/transactions/adjustments
Dieser Endpunkt kann verwendet werden, um eine Liste der Anpassungstransaktionen bereitzustellen, die im System stattgefunden haben. Über diesen Endpunkt erhalten wir einen zurückgegebenen Eintrag, wenn die Menge einer Charge über Control Center oder WMS geändert (oder angepasst) wird. Dies kann auf Schäden oder abgelaufene Waren zurückzuführen sein, die aus dem System entfernt werden müssen.
Ein Beispielexport dieser Art könnte wie folgt aussehen:
Wie wir hier sehen können, handelt es sich um einen einzelnen Eintrag für ein Ereignis mit dem Deskriptor 'ADJUSTMENT' , der keine der möglicherweise überflüssigen verschachtelten Daten enthält, die wir beim generischen Endpunkt gesehen haben.
Eine Beispieldatei dieses Typs kann hier heruntergeladen werden.
Nützlich zum:
2.2. Batch-Verbrauchstransaktionen
Endpunkt/URI –
http://host:port/V5-API/api/integrate/export/transactions/batching/{completedBatches}
Der Export von Batch-Verbrauchstransaktionen liefert eine vereinfachte JSON-Datei, die Verbrauchs- und Produktionsdeskriptordaten für einen bestimmten, abgeschlossenen Batch enthält , der vom System verarbeitet wurde.
Mithilfe dieses Endpunkts erhalten wir eine Übersicht über alle Waren, die bei der Chargenbildung verbraucht wurden, sowie darüber, wie viel von den Chargen selbst anschließend produziert wurde.
Ein Beispiel für diesen Dateityp kann hier heruntergeladen werden.
Nützlich zum:
2.3. Batch-Verbrauchstransaktionen (Filterdatum)
Endpunkt/URI –
http://host:port/V5-API/api/integrate/export/transactions/batching/filterfrom/{filterDate}
Dieser Endpunkt gibt die gleichen Informationen zurück wie „Batch Consumption“ oben, ermöglicht jedoch bei Bedarf einen Filter nach Datum (Epochenzeitstempel), um die Ergebnisse einzugrenzen.
Nützlich zum:
2.4. Bestelltransaktionen
Endpunkt/URI exportieren –
http://host:port/V5-API/api/integrate/export/transactions/purchase
Ein Export von Kauftransaktionen von diesem Endpunkt liefert eine vereinfachte JSON-Datei, die Empfangsdaten zu Bestellungen enthält, einschließlich Systembeschreibungen wie 'RECEIVED'.
Der Endpunkt stellt diese Daten nur für abgeschlossene Bestellungen bereit, die nicht als exportiert markiert wurden.
Ein Beispiel für diesen Dateityp kann hier heruntergeladen werden.
Nützlich zum:
2.5. Kundenauftragstransaktionen
Endpunkt/URI exportieren –
http://host:port/V5-API/api/integrate/export/transactions/sales/{true/false}
Der Export von Verkaufstransaktionen über diesen Endpunkt liefert eine vereinfachte JSON-Datei mit Daten zu Zuordnung, Kommissionierung und Versand, die für Verkaufsaufträge relevant sind. Über diesen Endpunkt werden Daten zu allen über Verkaufsaufträge verkauften Artikeln sowie Beschreibungen wie „Kommissioniert“ und „Versendet“ zurückgegeben.
Der Endpunkt kann diese Daten für abgeschlossene Bestellungen (true) oder alle Bestellungen (false) bereitstellen, sofern diese Bestellungen nicht bereits als exportiert markiert wurden.
Ein Beispiel für diesen Dateityp kann hier heruntergeladen werden.
Nützlich zum:
