REST-API: Import grundlegender Entitäten V1
Diese Quelle dient dazu, grundlegende Entitäten wie Filialen, Kategorien oder geplante Ersatzlieferungen in Quant zu importieren. Das Eingabe- und Ausgabeformat ist JSON.
Verwenden Sie den Abschnitt Automatische Aufgaben, um einen Import zu erstellen und einzurichten. Nach der Erstellung enthält die Aufgabenliste die ID, die Sie in der Anfrage-URL übergeben.
- Einstellungen
Bevor Sie die API nutzen können, müssen Sie die folgenden Attribute auf der Registerkarte Einstellungen bearbeiten:
- Aktivieren Sie das Attribut Aktiviert, um die Aufgabe zu aktivieren.
- Wählen Sie unter Benutzer mit API-Zugriffsberechtigung einen oder mehrere Benutzer mit der Rolle Roboter aus, die die Berechtigung zum Ausführen der Aufgabe erhalten sollen.
- Wählen Sie unter Basisentität für den Import die Entität aus, die Sie importieren möchten.
- Wählen Sie unter Zuordnungsattribut das Attribut aus, das verwendet werden soll, um die bestehenden Werte mit den neuen zu verknüpfen.
- Wählen Sie im Bereich Attributzuordnung die zu importierenden Attribute aus und ändern Sie optional deren JSON-Schlüssel.
Attributes
Attribut | Beschreibung | Typ |
Aktiviert | Gibt an, ob der Benutzer auf diese Ressource zugreifen darf. | ja/nein |
Titel | Benutzerdefinierter Name der automatisierten Aufgabe. | Text |
Beschreibung | Benutzerdefinierte Beschreibung der automatischen Aufgabenfunktion. | formatierter Text |
Notizen | Notizen. | Langtext |
Benutzer mit API-Zugriffsberechtigung | Benutzer mit der Rolle Robot, die zur Ausführung der Aufgabe berechtigt sind. | Benutzerliste |
Grundlegende Entität für den Import | Gibt die Entität an, für die der Import durchgeführt werden soll. | Auswahl |
Übereinstimmendes Attribut | Gibt das Attribut an, anhand dessen neue Werte mit bestehenden abgeglichen werden. | Auswahl |
Produktzuordnungsattribut | Gibt das Attribut an, anhand dessen neue Produktwerte mit bestehenden abgeglichen werden. | Auswahl |
Attributzuordnung | Das Entitätsattribut in Quant, das zum Abgleich mit den Elementen aus dem Import verwendet wird. | komplexer Typ |
Neue Elemente erstellen | Wenn diese Option aktiviert ist, werden beim Import neue Einträge für nicht vorhandene, übereinstimmende Attribut-IDs erstellt. | ja/nein |
Gelöschte Elemente ignorieren | Wenn der Import für eine bestimmte ID keinen aktiven Eintrag findet, durchsucht er standardmäßig die gelöschten Einträge. Findet er einen gelöschten Eintrag, wird dieser wieder aktiviert. Durch Aktivieren dieser Option werden gelöschte Einträge ignoriert, anstatt sie wiederherzustellen. | ja/nein |
Verzögerung in Sekunden vor dem erneuten Versuch | Die Anzahl der Sekunden, die der Client warten soll, bevor er den Import erneut versucht, falls eine lange Warteschlange von Anfragen an den Server vorliegt. | ganze Zahl |
Maßeinheit | Maßeinheiten wie cm, mm usw. | Auswahl |
Datumsformat | Format für die Datumsangabe, z. B. 31.12.19 | Auswahl |
Datums- und Zeitformat | Datums- und Zeitformat, z. B. 31.12.19 23:59:59 | Auswahl |
Trennzeichen für Listenelemente | Zeichen zum Trennen der Elemente der Werteliste. | Zeichen |
- Anfrage
/v1/import/basic-entities/{task_id}
Parameter | Wert |
URL | ?debug zur URL hinzugefügt wird, wird in der Antwort auch eine Warnung angezeigt. Ohne sie werden nur Fehler aufgeführt. |
Kopfzeile | Accept: application/json |
Kopfzeile | Content-type: application/json |
Kopfzeile | Authorization: Bearer <TOKEN> TOKEN erhält man über /authenticate (siehe Login). |
Methode | POST |
Der Inhalt der Anfrage ist ein Array aus JSON-Objekten, das die in der Einstellung Attributzuordnung definierten Schlüssel enthält.
Es ist wichtig, dass die Anfrage den JSON-Standards entspricht. Diese sind beispielsweise hier definiert. Bitte senden Sie numerische Attributwerte ohne Anführungszeichen, siehe Beispiel.
Antwort
Schlüssel | Wert |
Status | Eine String, der den endgültigen Status des Imports beschreibt.
|
Warnungen | Optional - nur enthalten, wenn der Parameter ?debug in der URL enthalten ist und der Import mindestens eine Warnung erzeugt hat. Liste der Warnstrings. |
Fehler | Optional - nur enthalten, wenn der Import mindestens einen Fehler verursacht hat. Liste der Fehlerstrings. |
Gesamtzahl der Zeilen | Optional – wird nur angegeben, wenn der Import nicht mit dem Status „FAILURE“ abgeschlossen wurde. |
Dupliziert | Optional – wird nur angegeben, wenn der Import nicht mit dem Status „FAILURE“ abgeschlossen wurde Die Anzahl der Datensätze, die übersprungen wurden, da dieser Eintrag bereits in derselben Anfrage importiert wurde. |
Leere IDs | Optional – wird nur angezeigt, wenn der Import nicht mit dem Status „FAILURE“ abgeschlossen wurde. Die Anzahl der Datensätze, die übersprungen wurden, da keine übereinstimmende Anforderungs-ID gefunden wurde. |
Ignoriert | Standardmäßig wird, wenn der Import kein aktives Element mit der angegebenen ID finden kann, stattdessen die Liste der gelöschten Elemente durchsucht. Wird ein gelöschtes Element gefunden, wird es wiederhergestellt. Wenn diese Option aktiviert ist, werden gelöschte Elemente ignoriert, anstatt wiederhergestellt zu werden. |
Status Codes
Status | Wert |
200 OK | Import erfolgreich mit Status "SUCCESS" oder "PARTIAL_SUCCESS". Die Antwort kann Warnungen oder kleinere Fehler enthalten. |
400 Bad Request | Falsche Aufgabeneinstellungen oder falsche Anfrage. |
401 Unauthorized | Das Berechtigungs-Token ist ungültig, oder der mit dem Token angemeldete Benutzer hat keine Berechtigung zur Ausführung dieser Aufgabe. |
404 Not Found | Es wurde keine Aufgabe mit der in der URL angegebenen ID gefunden. |
500 Internal Server Error | Während des Imports ist ein kritischer serverseitiger Fehler aufgetreten. |
503 Service Unavailable | Die Aufgabe läuft bereits. Der Start der Aufgabe wird nach der im Antwortkopf Retry-After angegebenen Anzahl von Sekunden wiederholt. |
Aktuelle Logs
In Quant können Sie neben den Aufgabeneinstellungen auch die Protokolle einzelner Importe einsehen, einschließlich Statistiken, Fehlern und Warnungen.
Um die Details eines bestimmten Eintrags anzuzeigen, wählen Sie diesen aus und klicken Sie auf die Schaltfläche Dateien herunterladen.
Anfrage
curl -X POST --location "https://[YOUR_COMPANY].iquant.eu/v1/import/basic-entities/959977?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \-d "[ {"id":"CAT001","name":"Number 1","prodAt": ["External ID attribute 1","External ID attribute 2"]},
{"id":"CAT002","name":"Number 2","prodAt": "External ID attribute 1"},
{"id":"CAT003","name":"Number 3","prodAt": ["External ID attribute 1","External ID attribute 4","External ID attribute 5"]
"}]"
Antwort
{
"Status": "SUCCESS",
"Total Lines": 4,
"Duplicated": 0,
"Empty Ids": 1,
"Ignored": 0
}