REST-API-Ausstattung-Bilder exportieren

REST API Fixture Images Export // REST-API-Ausstattung-Bilder exportieren

Diese Quelle wird verwendet, um Daten zu Fotos von Einrichtungsgegenständen aus Quant zu exportieren. Derzeit wird JSON als Ausgabeformat verwendet.

Der Export kann nur von Quant-Nutzern mit der Rolle Robot aufgerufen werden, für die dieser Export in den Einstellungen aktiviert ist. Andernfalls wird der Export nicht durchgeführt und die Status-Eigenschaft in der Antwort enthält eine Fehlermeldung:

HTTP 401 {"token":"<TOKEN>","status":"User is not authorized for this Resource."}

Anfrage

Parameter	Wert
URL	/equipmentImagesDataExport/json
Debuggen	?debug=true zur URL hinzugefügt wird, wird in der Antwort ebenfalls eine Warnung angezeigt. Ohne diese Angabe werden nur Fehler aufgelistet.
Kopfzeile	Accept: application/json
Kopfzeile	Authorization: Bearer <TOKEN> TOKEN wird mithilfe von /authenticate abgerufen (siehe Handbuch REST API Einführung und Anmeldung).
Verfahren	GET

Attributes

Die Exporteinstellungen werden ebenfalls vom Nutzer eingerichtet (siehe Abbildung oben).

Attribute	Beschreibung	Type
Aktiviert	Legt fest, ob die automatische Aufgabe aktiv ist und Daten über sie gesendet werden können.	ja/nein
Titel	Benutzerdefinierter Name der automatischen Aufgabe.	Text
Beschreibung	Eigene Beschreibung der automatischen Aufgabenfunktion.	formatierter Text
Notizen	Notizen.	langer Text
Neue Elemente exportieren als	Datumsbegrenzung für die Liste der exportierten Bilder. Wenn dieses Feld ausgefüllt ist, werden nur Bilder exportiert, die nach diesem Datum hochgeladen wurden.	Datum
Kommentare einfügen	Wenn diese Option aktiviert ist, wird die Bild-ID einschließlich benutzerdefinierter Anpassungen exportiert, andernfalls die ursprüngliche Bild-ID ohne Anpassungen.	ja/nein
Maximale Bildbreite des Planograms (px)	Gibt die maximale Breite des herunterzuladenden Planogrammbildes in Pixeln an.	positive ganze Zahl
Maximale Höhe des Planogrammbildes (px)	Gibt die maximale Höhe des herunterzuladenden Planogrammbildes in Pixeln an.	positive ganze Zahl
Datumformat	Datumsformat, z. B.: 12/31/20.	Selektion

Antwort

Parameter	Wert
Körper	{"token":"<TOKEN>","status":"<STATUS>,"Total Lines":<LINE_COUNT>,"Ignored Pictures":<IGNORED>," Records“:<RECORDS>,“Errors“:[ERRORS], “Warnings“:[WARNINGS]“}

Attribute	Beschreibung	Type
Token	Token der Nutzerberechtigung.	Text
Status	ERFOLG, wenn alle Bilder im ausgewählten Zeitraum korrekt exportiert wurden, TEILERFOLG, wenn der Export erfolgreich war, jedoch einige Bilder nicht exportiert wurden, und FEHLER, wenn ein unerwarteter Fehler den Export vorzeitig beendet hat.	Text
Gesamtzeilenzahl	Anzahl der Datensätze bei der Ausgabe.	Zahl
Ignorierte Bilder	Die Anzahl der Bilder, die nicht exportiert wurden, da sie keiner Ausstattung zugeordnet waren.	Zahl
Ergebnisse	Liste der exportierten Datensätze.	JSON Array
Errors	Eine Reihe von JSON-Objekten, die Fehler beschreiben. Wenn es leer ist, wird es nicht aufgeführt.	JSON Array
Warnungen	eine Reihe von JSON-Objekten, die Fehler beschreiben. Wenn es leer ist, wird es nicht aufgeführt.	JSON Array

Execution Log

In Quant können Sie zusätzlich zu den Importeinstellungen in der Roboterrolle auch Umsetzungsprotokolle einzelner Exporte einsehen, einschließlich Statistiken, Fehlern, Warnungen und allgemeinen Informationen.

Schaltfläche Artikel anzeigen

Wenn Sie einen bestimmten Datensatz auswählen, können wir dessen Details anzeigen, indem Sie auf die Schaltfläche Elemente anzeigen klicken (siehe Abbildung unten). Nachdem Sie die ausgewählten Elemente markiert haben, klicken Sie auf Dateien herunterladen. Diese Dateien enthalten die Ausgabedaten für den jeweiligen Exportlauf.

Schaltfläche Dateien herunterladen

Anfrage

curl -H "accept: application/json" -H "Authorization: Bearer i37YKbgCnJSXe2nvIrHA1fE8bLIE4RqROu4l1AOTzHZXSmZ3CX" -G https://[YOUR_COMPANY].iquant.eu/equipmentImagesDataExport/json?debug=true

Das folgende Beispiel erläutert, wie Sie den Exportvorgang starten können, nachdem Sie sich angemeldet und einen TOKEN erhalten haben.

Antwort

{"token":"i37YKbgCnJSXe2nvIrHA1fE8bLIE4RqROu4l1AOTzHZXSmZ3CX","status":"SUCCESS","Total Lines":2,"Ignored Pictures":1,"Records": [{"EquipmentID":"b098ed39-f826-4827-aafa-acc85ebf6ee6","ID":"735076","Uploaded":"30.09.20","Uploaded By":"[Správce pobočky] jakab.t_det.store","Photo ID":"105","Implemented Planogram Id":"96444","Title":"","Description":""},{"EquipmentID":"2d212db0-0efd-4dfd-90a5-eac838d026d3","ID":"735075","Uploaded":"30.09.20","Uploaded By":"[Správce pobočky] jakab.t_det.store","Photo ID":"104","Implemented Planogram Id":"1578","Title":"","Description":""}], "Warnings":["Equipment Photo with ID "425742" has no equipment assigned."]}

Diese Antwort bedeutet einen erfolgreichen Export mit einer Warnung. Details und Statistiken finden Sie dann in Quant.

Format der exportierten Datensätze

Jeder Exportdatensatz enthält die folgenden Elemente:

Name	Beschreibung	Type
Equipment ID	ID der Ausstattung, zu der das Bild gehört.	Text
ID	Bild-ID.	Text
Hochgeladen	Datum des Hochladens des Bildes.	Datum
Hochgeladen von	Nutzer, der das Bild hochgeladen hat.	Text
PhotoID	ID zum Herunterladen des Fotos (siehe Anweisungen unten).	Text
Implementiertes Planogramm-ID	ID zum Herunterladen des Planogrammbildes, zu dem das Foto gehört (siehe Anweisungen unten). Wenn dieses Feld leer ist, wurde das Foto nicht als Implementierungsfoto hochgeladen.	Text
Titel	Name des Bildes, der vom Nutzer eingegeben wurde.	Text
Beschreibung	Beschreibung des Bildes, die vom Nutzer eingegeben wurde.	Text

Ausstattung-Foto herunterladen

Um ein Foto der Ausstattung herunterzuladen, verwenden wir das Element PhotoID aus dem ausgewählten Exportdatensatz.

Anfrage

Parameter	Value
URL	/downloadImage/<PhotoID>
Kopfzeile	Authorization: Bearer <TOKEN> TOKEN wird mithilfe von /authenticate abgerufen (siehe Handbuch REST API Einführung und Anmeldung).
Verfahren	GET

Garage

curl -o image.jpg -H "Authorization: Bearer i37YKbgCnJSXe2nvIrHA1fE8bLIE4RqROu4l1AOTzHZXSmZ3CX" -G https://[YOUR_COMPANY].iquant.eu/downloadImage/105

Antwort

Ein binäres JPEG-Bild.

Planogrammfoto herunterladen

Um das Planogramm-Bild herunterzuladen, verwenden Sie bitte das Element Implementierte Planogramm-ID aus dem ausgewählten Exportdatensatz.

Anfrage

Parameter	Value
URL	/downloadPlanogramImage/<PlanogramID>
Kopfzeile	Authorization: Bearer <TOKEN> TOKEN wird mithilfe von /authenticate abgerufen (siehe Handbuch REST API Einführung und Anmeldung).
Verfahren	GET

Anfrage

curl -o planogram.jpg -H "Authorization: Bearer i37YKbgCnJSXe2nvIrHA1fE8bLIE4RqROu4l1AOTzHZXSmZ3CX" -G https://[YOUR_COMPANY].iquant.eu/downloadPlanogramImage/96444>

Antwort

Es wird ein binäres JPEG-Bild mit Abmessungen erstellt, das innerhalb der in den Exporteinstellungen eingerichteten Grenzen liegt.

←REST-API Export von Bilddaten für die Ausstattung V1

REST API Export platzierter Produkte V1→