REST API Export dat fotek vybavení V1

Tento zdroj slouží k exportu dat o fotkách vybavení v Quantu. Vstupním i výstupním formátem je JSON.

Pro vytvoření a nastavení exportu použijte sekci Automatické úlohy. Po vytvoření bude v seznamu úloh ID, které předáte v URL požadavku.

ID úlohy 
  • Nastavení

Před použitím API je nutno upravit tyto atributy v záložce Nastavení:

  • Zaškrtněte atribut Zapnuto pro povolení úlohy
  • V atributu Uživatelé s povoleným přístupem pro API zvolte jednoho nebo více uživatelů s rolí Robot, kteří budou mít oprávnění úlohu spouštět
  • V atributu Mapování atributů obrázků vybavení zvolte atributy pro export a volitelně upravte jejich JSON klíče
  • Atributy
Atribut
Popis
Typ
Zapnuto
Určuje, zda je daná automatické úloha aktivní a mohou přes ní být posílána data.
ano/ne
Titul
Vlastní název automatické úlohy.
text
Popis
Vlastní popis funkce automatické úlohy.
formátovaný text
Poznámky
Poznámky.
dlouhý text
E-maily pro notifikace

Jedna nebo více e-mailových adres, na které budou zasílány e-maily s chybovými stavy.

seznam řetězců
Uživatelé s povoleným přístupem pro API
Uživatelé s rolí Robot, kteří jsou oprávněni úlohu spouštět.
seznam uživatelů
Jednotka rozměru
Měrná jednotka jako cm, mm atd.
výběr
Formát dat
Formát zápisu data, např. 31.12.19
výběr
Formát datumu a času
Formát zápisu data a času, např. 31.12.19 23:59:59
výběr
Exportovat novější než
Datum omezující seznam exportovaných obrázků. Když je vyplněné, exportují se pouze obrázky nahrané po tomto datu.
datum
Zahrnout úpravy
Je-li zapnutý, exportuje se ID obrázku včetně uživatelských úprav, jinak ID původního obrázku bez úprav.
ano/ne
Maximální šířka obrázku planogramu (px)
Udává maximální šířku obrázku planogramu ke stažení v pixelech.
přirozené číslo
Maximální výška obrázku planogramu (px)
Udává maximální výšku obrázku planogramu ke stažení v pixelech.
přirozené číslo
Mapování atributů obrázků vybavení
Mapování obsahující položku pro každý atribut fotky, který má být exportován.
komplexní typ
Nastavení
  • Požadavek

/v1/export/fixture-image-data/{id_ulohy}

Parametr
Hodnota
URL
?debug přidaný do URL zobrazí v odpovědi i varování. Bez toho se vypisují pouze chyby.
Hlavička
Accept: application/json
Hlavička
Content-type: application/json
Hlavička

Authorization: Bearer  <TOKEN>

TOKEN se získává pomocí /authenticate (viz. Přihlášení).

Metoda
POST

Obsah požadavku může být vynechán (prázdný text), nebo jím může být prázdný JSON objekt.

  • Odpověď
Klíč
Hodnota
Status
Řetězec popisující výsledný stav exportu.
  • SUCCESS = bezchybný průběh exportu
  • PARTIAL_SUCCESS = export proběhl, ale vygeneroval jedno nebo více varování
  • FAILURE = při exportu nastala jedna nebo více chyb
Warnings
Volitelný - je zahrnut pouze, pokud je v URL parametr ?debug a export vygeneroval alespoň jedno varování.
Seznam řetězců s varováními.
Errors
Volitelný - je zahrnut pouze, pokud export vygeneroval alespoň jedno chybu.
Seznam řetězců s chybami.
Records

Volitelný - je zahrnut pouze, pokud export neskončil se stavem "FAILURE".

Seznam exportovaných objektů. Každý objekt obsahuje klíče definované mapováním v nastavení úlohy.

  • Stavové kódy
Stav
Význam
200 OK
Export proběhl úspěšně s výsledným stavem "SUCCESS" nebo "PARTIAL_SUCCESS". Odpověď může obsahovat varování nebo nezávažné chyby.
400 Bad Request
Chybné nastavení úlohy nebo chybný požadavek.
401 Unauthorized
Autorizační token je neplatný, nebo uživatel, který je tokenem přihlášen, nemá oprávnění spouštět tuto úlohu.
404 Not Found
Nebyla nalezena úloha s ID daným v URL.
500 Internal Server Error

Během exportu nastala kritická chyba na straně serveru.

503 Service Unavailable

Export již běží. Zkuste to spustit znova za počet sekund udávaných v hlavičce Retry-After.

  • Záznam průběhu

V Quantu vedle nastavení úlohy lze prohlížet i záznamy průběhů jednotlivých exportů, včetně statistik, chyb, a varování.

Záznam průběhu 

Vybereme-li konkrétní záznam, můžeme zobrazit jeho detaily tlačítkem Zobrazit položky.

Zobrazení detailů záznamu


  • Požadavek

curl -X POST --location "http://localhost:4150/v1/export/fixture-image-data/151?debug" \

    -H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \

    -H "Accept: application/json" \

    -H "Content-Type: application/json" \

    -H "Cache-Control: no-cache" \

    -d '{}'

  • Odpověď

{

  "Status": "SUCCESS",

  "Total Lines": 50,

  "Ignored Pictures": 0,

  "Records": [

    {"Photo ID": "89", "Assigned Fixtures": ["6a0d7e43-c6d5-4247-98c1-2b4f3f9ddf99"], "Implemented Planogram Id": "446319"},

    {"Photo ID": "162", "Assigned Fixtures": ["83c5b2da-23af-4ad6-8a57-fcb8bc4ca12a"], "Implemented Planogram Id": ""},

    ... ]

}