REST-API: Import benutzerdefinierter Eigenschaften V1
Diese Quelle dient zum Importieren benutzerdefinierter Eigenschaften in Quant. 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, müssen Sie die folgenden Attribute auf der Registerkarte Einstellungen bearbeiten:
- Aktivieren Sie das Kontrollkästchen Aktiviert, um die Aufgabe zu aktivieren.
- Wählen Sie unter Benutzer mit API-Zugriffsberechtigung einen oder mehrere Benutzer mit der Rolle Robot aus, die die Berechtigung zum Ausführen der Aufgabe erhalten sollen.
- Wählen Sie im Attribut Benutzerdefinierte Eigenschaft für den Import die Entität aus, für die die optionale Eigenschaft angelegt werden soll.
- Über die Zuweisung benutzerdefinierter Eigenschaftstypen können Sie die Zuordnung für einzelne Feldtypen wie Dezimalzahl, Datum oder einzeiliger Text konfigurieren.
- Wählen Sie in der Zuweisung von Attributen für benutzerdefinierte Eigenschaften die zu importierenden Attribute aus und ändern Sie optional deren JSON-Schlüssel.
- Wir empfehlen außerdem, das Feld E-Mail-Adressen für Benachrichtigungenauszufüllen, in das Sie eine oder mehrere E-Mail-Adressen eingeben können, an die Fehlerbenachrichtigungen gesendet werden sollen.
- Attribute
Atribute | Beschreibung | Typ |
Aktiviert | Gibt an, ob der Benutzer auf diese Ressource zugreifen kann. | Ja/Nein |
Titel | Benutzerdefinierter Name für die automatisierte Aufgabe. | Text |
Beschreibung | Benutzerdefinierte Beschreibung der automatischen Aufgabenfunktion. | formatierter Text |
Bemerkungen | Bemerkungen. | Longtext |
Emails für Benachrichtigungen | Eine oder mehrere E-Mail-Adressen, an die E-Mails mit Fehlerbedingungen gesendet werden sollen. | Liste von Strings |
Benutzer mit API-Zugriffsberechtigung | Benutzer mit der Rolle Roboter, die berechtigt sind, die Aufgabe auszuführen. | Liste der Benutzer |
Benutzerdefinierte Eigenschaft für den Import | Hier wird die Entität angegeben, für die die benutzerdefinierte Eigenschaft angelegt werden soll. Dies könnte beispielsweise ein Produkt sein. | Auswahl |
Zuordnung benutzerdefinierter Datentypen | Dies ist ein Attribut des benutzerdefinierten Eigenschaftstyps, das dazu dient, einzelne Typen benutzerdefinierter Eigenschaften zuzuordnen, wie beispielsweise eine Dezimalzahl, ein Datum oder eine einzelne Textzeile. | komplexer Typ |
Verzögerung in Sekunden vor dem erneuten Versuch | Dies ist die Anzahl der Sekunden, die der Client warten soll, bevor er den Import erneut versucht, falls eine lange Warteschlange von Anfragen an den Server besteht. | ganze Zahl |
Zuordnung von benutzerdefinierten Eigenschaften | Eine Zuordnung, die für jedes zu importierende Attribut einen Eintrag enthält. | komplexer Typ |
Maßeinheit | Maßeinheit wie cm, mm, usw. | Auswahl |
Datum Format | Format der Datumseingabe, z.B. 31.12.19 | Auswahl |
Format von Datum und Uhrzeit | Datum und Zeitformat, z.B. 31.12.19 23:59. | Auswahl |
Listenelement-Trennzeichen | Zeichen für die Aufteilung der Elemente der Werteliste. | Zeichen |
- Anfrage
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 is received via /authenticate (see Login). |
Methode | POST |
Der Inhalt der Anfrage ist ein Array aus JSON-Objekten, das die Schlüssel enthält, die in der Einstellung Zuordnung benutzerdefinierter Eigenschaften definiert sind.
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.
- Anfrage
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. |
Gesamtzeilen | Optional – wird nur angegeben, wenn der Import nicht mit dem Status „FAILURE“ abgeschlossen wurde. Anzahl der Datensätze bei der Eingabe. |
Doppelte Produkte | Optional – wird nur angezeigt, wenn der Import nicht mit dem Status „FEHLER“ abgeschlossen wurde. Die Anzahl der Datensätze, die übersprungen wurden, da dieses Produkt bereits in derselben Anfrage importiert wurde. |
Ausgeblendete Produkte | Standardmäßig sucht der Import, wenn er kein aktives Produkt mit der angegebenen ID findet, stattdessen in der Liste der gelöschten Produkte. Wird ein gelöschtes Produkt gefunden, wird es wiederhergestellt. Wenn diese Option aktiviert ist, werden gelöschte Produkte ignoriert, anstatt wiederhergestellt zu werden. |
- Statuscodes
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. |
- Neueste Logs
In Quant können Sie neben den Aufgabeneinstellungen auch die Protokolle einzelner Importe einsehen, einschließlich Statistiken, Fehlern und Warnungen.
Wir können die Details eines bestimmten Datensatzes anzeigen, indem wir ihn auswählen und auf die Schaltfläche Dateien herunterladen klicken.
- Anfrage
curl -X POST --location "https://[YOUR_COMPANY].iquant.eu/v1/import/custom-properties/959977?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d "[ {"id":"num1","name":"Number 1","type":"num", "store_specific":true, "group": "REST"},
{"id":"date1","name":"Date name 1","type":"Date", "store_specific":false, "group": "Date Group"},
{"id":"date2", "name": "Date name 2", "type":"Date"},
{"name":"Text name","type":"text", "store_specific":true, "group": "REST"}
]"
- Antwort
{
"Status": "SUCCESS",
"Total Lines": 4,
"Duplicated Products": 0,
"Ignored Products": 0
}