REST-API-Analyse-Export

Mithilfe dieser Quelle können Analysen in Quant exportiert werden. Es können die folgenden Analysen exportiert werden: Platzierte Produkte Überblick, Kategoriechancen, Ausstattungsüberblick, Publizierte Projektplanogramme, Publizierte eigenständige Planogramme, Geplante Ersetzungen, Formularergebnisse, Analyse der Implementierungsfotos. Sowohl das Eingabe- als auch das Ausgabeformat ist JSON.

Platzierte Produkte Überblick
Damit können Sie entweder Planogramm- oder Backstock-Produkte exportieren. Die Analyse bietet Ihnen einen Überblick über alle Produkte auf Planogrammen mit dem ausgewählten Lebenszyklusstatus.

Kategoriechancen
Es bietet einen detaillierten Vergleich der Fläche, die einer bestimmten Produktkategorie in einer Filiale zugewiesen ist, und berücksichtigt dabei sowohl die verfügbare Ausstattung als auch den Umsatz der Produkte dieser Kategorie.

Ausstattungsüberblick
Es bietet einen Überblick über alle Ausstattungen, die sich in den Filialen befinden.

Publizierte Projektplanogramme
Es bietet einen Überblick über alle Planogramme aus allen Projekten.

Publizierte eigenständige Planogramme
Es bietet einen Überblick über alle eigenständigen Planogramme.

Geplante Ersetzungen
Es zeigt den geplanten Austausch von Produkten in ausgewählten Filialen an.

Formularergebnisse
Es bietet einen Überblick über alle ausgefüllten Formulare.

Analyse der Implementierungsfotos
Es wird eine Übersicht der Implementierungsfotos angezeigt.

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.

Automatische Aufgabe
Aufgaben-ID
  • 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 der Zuordnung der Analyseattribute die zu exportierenden Attribute aus und bearbeiten Sie optional deren JSON-Schlüssel. 
  • Weiterhin empfehlen wir Ihnen, das Feld E-Mail-Adressen für Benachrichtigungen auszufüllen, in dem Sie eine oder mehrere E-Mail-Adressen angeben, an die E-Mails mit Fehlermeldungen gesendet werden sollen.
  • 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
Zuordnung der Analyseattribute
Eine Zuordnung, die einen Eintrag für jede Eigenschaft enthält, die exportiert werden soll.
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


Einstellungen und wichtige Eigenschaften
  • 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

Der Inhalt der Analyseanforderung Ausstattungsüberblick ist ein JSON-Objekt mit folgenden Schlüsseln

Schlüssel 
Wert
StoreID
In der Anfrage muss angegeben werden, für welche Filiale die Produktdaten exportiert werden sollen. Es kann jeweils nur eine Filiale ausgewählt werden.
Beispiele:
{ "StoreID":"12"}
  • Antwort
Schlüssel 
Wert
Status
Eine String, der den endgültigen Status des Exports beschreibt.
  • SUCCESS = fehlerfreier Exportprozess
  • PARTIAL_SUCCESS = Export abgeschlossen, aber eine oder mehrere Warnungen erzeugt
  • FAILURE = ein oder mehrere Fehler während des Exports aufgetreten sind
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.

Ausführungslog

Wenn wir einen bestimmten Datensatz auswählen, können wir seine Details anzeigen, indem wir auf die Schaltfläche Artikel anzeigen klicken.

Artikel anzeigen


  • Anfrage für Platzierte Produkte Überblick, Kategoriechancen, Publizierte Projektplanogramme, Publizierte eigenständige Planogramme, Geplante Ersetzungen, Formularergebnisse, Analyse der Implementierungsfotos

curl -X POST --location "http://[YOUR_COMPANY].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" \

  • Anfrage für Ausstattungsüberblick

curl -X POST --location "http://[YOUR_COMPANY].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" \
-d "[{ \"StoreID\": \"12564\"}]"

  • Antwort

{
  "Status": "SUCCESS", "Records": [
  {"Store ID": "234", "Store Name": "Kutná Hora", "City": "Kutná Hora", "Fixture type": "Freezer", "Number of Shelves": "5", "Category Name": "Doplňky", "Category Id": "CAT6"},
  {"Store ID": "238", "Store Name": "Ostrava-Svinov", "City": "Ostrava", "Fixture type": "Default", "Number of Shelves": "6", "Category Name": "Yoga", "Category Id": "CAT931"},
  {"Store ID": "545", "Store Name": "Kolín", "City": "Kolín", "Fixture type": "Default", "Number of Shelves": "6", "Category Name": "Milk", "Category Id": "CAT14"},
    ... ]
}