Featureinformationen
Fachlicher Mehrwert
Cloud4Log bildet den standardisierten Lieferscheinprozess ab. Unternehmen haben jedoch häufig individuelle Prozessdaten, die über den Standard hinausgehen -- etwa interne Referenznummern, Kostenstellen, Projektzuordnungen, Dispositionshinweise oder kundenspezifische Kennzeichnungen.
Mit diesem Feature können Unternehmen beliebige Schlüssel-Wert-Paare als Zusatzdaten (Metadaten) an einem Lieferschein hinterlegen und wieder abrufen. Die Vorteile:
- Individuelle Prozessdaten: Unternehmen können ihre eigenen, internen Informationen direkt am Lieferschein speichern, ohne dass der standardisierte Lieferscheinprozess verändert wird.
- Organisationsbezogene Trennung: Jede Organisation sieht ausschließlich die von ihr selbst hinterlegten Metadaten. Die Zusatzdaten anderer Organisationen sind nicht einsehbar.
- Flexibles Datenmodell: Es gibt kein festes Schema -- beliebige Schlüssel-Wert-Paare (Strings) können hinterlegt werden. Das ermöglicht die Anbindung unterschiedlichster IT-Systeme ohne Anpassung der API.
- Aktualisierbar: Bereits hinterlegte Metadaten können jederzeit überschrieben werden, solange der Lieferschein existiert.
Information für Frontend-Nutzer
Dieses Feature ist ein reines API-Feature. Es gibt keine Oberfläche im Frontend, um die Metadaten einzusehen oder zu bearbeiten. Die Daten werden ausschließlich über die API geschrieben und gelesen.
Information für API-Anbindung (fachliche Aspekte)
Endpunkte
| Methode | Pfad | Feature-Flag | Beschreibung |
|---|---|---|---|
| PUT | .../organizations/{organizationKey}/delivery-notes/{deliveryNoteKey}/metadata | deliveryNoteMetadata | Metadaten zu einem Lieferschein hinzufügen oder aktualisieren |
| GET | .../organizations/{organizationKey}/delivery-notes/{deliveryNoteKey}/metadata/{metaDataKey} | deliveryNoteMetadata | Einzelnen Metadaten-Wert eines Lieferscheins abrufen |
| Die Endpunkte sind in der Swagger-Dokumentation der Produktionsumgebung unter https://app.cloud4log-addons.com/api-docs/ vollständig dokumentiert. |
Hinweis: Die Endpunkte verwenden den organizationKey (nicht den organizationSiteKey). Die Metadaten sind an die Organisation gebunden, nicht an einen einzelnen Standort.
Fachliche Verwendung in eigenen Systemen
Die Metadaten-Endpunkte konnen genutzt werden, um unternehmensspezifische Informationen strukturiert am Lieferschein zu speichern und von dort wieder abzurufen. Typische Einsatzszenarien:
- ERP-Referenzen: Interne Auftragsnummern, SAP-Belegnummern oder Projektkennzeichen am Lieferschein hinterlegen, um die Zuordnung im eigenen System zu erleichtern.
- Dispositionshinweise: Lagerzuweisungen, Rampeninformationen oder Tourenreferenzen am Lieferschein speichern, die fur den internen Warenausgangsprozess relevant sind.
- Kundenspezifische Kennzeichnungen: Individuelle Klassifizierungen oder Tags, die für interne Auswertungen oder Reportings benötigt werden.
- Systemubergreifende Verknüpfung: Durch Hinterlegung von Fremdschlüsseln (z.B. WMS-Sendungsnummer, TMS-Tourennummer) kann der Lieferschein in Cloud4Log mit Vorgängen in anderen Systemen verknüpft werden. Die Daten sind organisationsbezogen isoliert: Jede Organisation kann nur ihre eigenen Metadaten lesen und schreiben.
Hinweise für Entwickler
Anbindung
Metadaten schreiben: PUT-Request mit einem JSON-Objekt aus beliebigen Schlüssel-Wert-Paaren (Strings) an den Endpunkt senden. Bei erneutem Aufruf werden bestehende Werte aktualisiert. Metadaten lesen: GET-Request mit dem gewünschten metaDataKey als Pfad-Parameter. Die Response enthält den gespeicherten Wert als String.
Beispiel: Metadaten schreiben
curl -X PUT
-H "Authorization: Bearer ${TOKEN}"
-H "Content-Type: application/json"
-d '{
"sapBelegnummer": "4500012345",
"kostenstelle": "KST-4711",
"lagerort": "Halle-3-Rampe-7"
}'
"https://app.cloud4log-addons.com/api/v2/organizations/{orgKey}/delivery-notes/{dnKey}/metadata"
Beispiel: Metadaten lesen
curl -s
-H "Authorization: Bearer ${TOKEN}"
"https://app.cloud4log-addons.com/api/v2/organizations/{orgKey}/delivery-notes/{dnKey}/metadata/sapBelegnummer"