REST-API-Analyse-Export
Diese Quelle wird für den Export von Analysen in Quant verwendet. Sie können die Analyse der Kategorie Chancen oder die Analyse der Ausstattungsüberblick exportieren. Das Eingabe- und Ausgabeformat ist JSON.
Im Abschnitt "Automatische Aufgaben" können Sie einen Export erstellen und einrichten. Nach der Erstellung erhält die Aufgabenliste die ID, die Sie in der Anfrage-URL angeben.
Einstellungen
Bevor Sie die API verwenden, müssen Sie die folgenden Attribute auf der Registerkarte Einstellungen bearbeiten:
- Markieren Sie das Attribut Aktiviert, um die Aufgabe zu aktivieren.
- Wählen Sie im Feld Benutzer mit API-Zugriffsberechtigung einen oder mehrere Benutzer mit der Rolle Roboter aus, die zur Ausführung der Aufgabe berechtigt sein sollen.
- Wählen Sie im Attribut Analysieren die Analyse aus, die Sie exportieren möchten.
- Wählen Sie in dem Mapping der Attribute Chance / Ausstattung Analyse die zu exportierenden Attribute aus und bearbeiten Sie optional deren JSON-Schlüssel.
Attribute
Attribute | Beschreibung | Typ |
Aktiviert | Gibt an, ob der Benutzer Zugang zu dieser Ressource hat. | Ja/Nein |
Titel | Benutzerdefinierter Name für die automatisierte Aufgabe | Text |
Beschreibung | Benutzerdefinierte Beschreibung der automatischen Aufgabenfunktion. | formatierter Text |
Bemerkungen | Bemerkungen. | Lang Text |
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 |
Verzögerung in Sekunden vor erneutem Versuch | Die Anzahl der Sekunden, die der Client warten soll, bevor er den Export erneut versucht, falls eine lange Warteschlange von Anfragen an den Server besteht. | Ganze Zahl |
Mapping der Attribute Chance-Analyse | Eine Zuordnung, die einen Eintrag für jedes zu exportierende Ausstattungsattribut enthält. | Komplexer Typ |
Mapping der Attribute Ausstattung-Analyse | Eine Zuordnung, die einen Eintrag für jedes zu exportierende Ausstattungsattribut enthält. | Komplexer Typ |
Maßeinheit | Maßeinheit wie cm, mm, usw. | Auswahl |
Datumsformat | Format der Datumseingabe, z.B. 31.12.19. | Auswahl |
Datums- und Uhrzeitformat | Datum und Zeitformat, z.B. 31.12.19 23:59:59. | Auswahl |
Listenelement-Trennzeichen | Kennzeichen für die Aufteilung der Elemente der Werteliste. | Kennzeichen |
Analysieren | Auswahl der Analyse. | Liste der Analysen |
Analysekriterien | Auswahl der Kriterieneinstellungen, nach denen die Analyse exportiert werden soll. | Komplexer Typ |
- Anfrage
/v1/export/analyze-report/{task_id}
Parameter | Wert |
URL | ?debug zur URL hinzugefügt wird, wird auch eine Warnung in der Antwort angezeigt. Ohne diese Option werden nur Fehler angezeigt. |
Kopfzeile | Accept: application/json |
Kopfzeile | Content-type: application/json |
Kopfzeile (optional) | Accept-Encoding: gzip |
Kopfzeile | Authorization: Bearer <TOKEN> TOKEN erhält man über /authenticate (siehe Login). |
Methode | POST |
Antwort
Schlüssel | Wert |
Status | Eine String, der den endgültigen Status des Exports beschreibt.
|
Warnungen | Optional - nur enthalten, wenn der Parameter ?debug in der URL enthalten ist und der Export mindestens eine Warnung erzeugt hat. Liste der Warn-Strings. |
Fehler | Optional - nur enthalten, wenn der Export mindestens einen Fehler erzeugt hat. Liste der Fehlerstrings. |
Datensatz | Optional - ist nur enthalten, wenn der Export nicht mit dem Status "FAILURE" beendet wurde Liste der exportierten Objekte. Jedes Objekt enthält die Schlüssel, die durch das Mapping in den Aufgabeneinstellungen definiert sind. |
Status Codes
Status | Wert |
200 OK | Export 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 | Es wurde keine Aufgabe mit der in der URL angegebenen ID gefunden. |
503 Service Unavailable | Der Export läuft bereits. Versuchen Sie, ihn in der in der Kopfzeile "Wiederholung nach" angegebenen Anzahl von Sekunden erneut auszuführen |
Ausführungslog
In Quant können Sie zusätzlich zu den Aufgabeneinstellungen auch Ausführungslog zu einzelnen Exporten einsehen, einschließlich Statistiken, Fehlern und Warnungen.
Wenn wir einen bestimmten Datensatz auswählen, können wir seine Details anzeigen, indem wir auf die Schaltfläche Artikel anzeigen klicken.
Anfrage
curl -X POST --location "http://[IHR_UNTERNEHMEN].iquant.eu/v1/export/analyze-report/117131?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
Antwort
{
"Status": "SUCCESS", "Records": [
{"Store ID": "234", "Name der Filiale": "Kutná Hora", "Stadt": "Kutná Hora", "Austattungstyp": "Freezer", "Anzahl der Regale": "5", "Kategorie Name": "Doplňky", "Kategorie Id": "CAT6"},
{"Store ID": "238", "Name der Filiale": "Ostrava-Svinov", "Stadt": "Ostrava", "Austattungstyp": "Default", "Anzahl der Regale": "6", "Kategorie Name": "Yoga", "Kategorie Id": "CAT931"},
{"Filial-ID": "545", "Name der Filiale": "Kolín", "Stadt": "Kolín", "Austattungstyp": "Default", "Anzahl der Regale": "6", "Kategorie Name": "Milk", "Kategorie Id": "CAT14"},
... ]
}