REST API Export fotek vybavení
Tento zdroj slouží k extrakci dat o fotkách vybavení z Quantu. Aktuálně používá JSON jako výstup.
K exportu může přistupovat pouze takový uživatel Quantu s rolí Robot, který má v nastavení povolen tento Export. V opačném případě se export neprovede a atribut status v odpovědi bude obsahovat chybovou hlášku:
HTTP 401 {"token":"<TOKEN>","status":"User is not authorized for this Resource."}
Požadavek
Parametr | Hodnota |
URL | /equipmentImagesDataExport/json |
Debug | ?debug=true přidaný do URL zobrazí v odpovědi i varování. Bez toho se vypisují pouze chyby. |
Header | Accept: application/json |
Header | Authorization: Bearer <TOKEN> TOKEN se získává pomocí /authenticate (více informací v manuálu REST API Úvod a přihlášení). |
Method | GET |
Atributy
Nastavení exportu se zadává také na uživateli (viz. obrázek výše).
Atribut | Popis | Typ |
Zapnuto | Určuje, zda uživatel může přistupovat k tomuto zdroji. | ano/ne |
Titul | Vlastní název zdroje v Quantu. | text |
Popis | Popis funkce zdroje. | formátovaný text |
Poznámky | Poznámky. | dlouhý text |
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 |
Formát dat | Formát zápisu data, např. 31.12.19 | výběr |
Odpověď
Parametr | Hodnota |
Body | {"token":"<TOKEN>","status":"<STATUS>,"Total Lines":<LINE_COUNT>,"Ignored Pictures":<IGNORED>," Records“:<RECORDS>,“Errors“:[ERRORS], “Warnings“:[WARNINGS]“} |
Atribut | Popis | Typ |
Token | Autorizační toke uživatele. | text |
Status | SUCCESS v případě, že se všechny obrázky ve vybraném časovém horizontu v pořádku vyexportovaly, PARTIAL_SUCCESS pokud export proběhl v pořáku, ale některé obrázky se nevyexportovaly a FAILURE v případě nečekané chyby, která předčasně zastavila export. | text |
Total Lines | Počet záznamů na výstupu. | číslo |
Ignored Pictures | Počet obrázků, které se nevyexportovaly kvůli tomu, že nebyly přiřazené k žádnému vybavení. | číslo |
Records | Seznam exportovaných záznamů. | JSON Array |
Errors | Pole JSON objektů popisující chyby. Pokud je prázdné, nevypisuje se. | JSON Array |
Warnings | Pole JSON objektů popisující varování (pouze pokud požadavek obsahoval parametr debug=true). Pokud je prázdné, nevypisuje se. | JSON Array |
Záznam průběhu
V Quantu vedle nastavení exportu na Robotovi lze prohlížet i záznamy průběhů jednotlivých exportů včetně statistik, chyb, varování a obecných informací.
Vybereme-li konkrétní záznam, můžeme zobrazit jeho detaily tlačítkem Zobrazit položky (viz obrázek níže). Pak po označení vybraných položek přepínačem ve druhém sloupci lze tyto stáhnout tlačítkem Stáhnout soubory. Tyto soubory obsahují výstupní data pro daný běh exportu.
Příklad
curl -H "accept: application/json" -H 'Authorization: Bearer i37YKbgCnJSXe2nvIrHA1fE8bLIE4RqROu4l1AOTzHZXSmZ3CX' -G https://[VASE_SPOLECNOST.iquant.eu/equipmentImagesDataExport/json?debug=true
Tento příklad znázorňuje pouštění exportu po předchozím získání TOKENu přihlášením.
Odpověď
{"token":"i37YKbgCnJSXe2nvIrHA1fE8bLIE4RqROu4l1AOTzHZXSmZ3CX","status":"SUCCESS","Total Lines":2,"Ignored Pictures":1,"Records": [{"EquipmentID":"b098ed39-f826-4827-aafa-acc85ebf6ee6","ID":"735076","Uploaded":"30.09.20","Uploaded By":"[Správce pobočky] jakab.t_det.store","Photo ID":"105","Implemented Planogram Id":"96444","Title":"","Description":""},{"EquipmentID":"2d212db0-0efd-4dfd-90a5-eac838d026d3","ID":"735075","Uploaded":"30.09.20","Uploaded By":"[Správce pobočky] jakab.t_det.store","Photo ID":"104","Implemented Planogram Id":"1578","Title":"","Description":""}], "Warnings":["Equipment Photo with ID '425742' has no equipment assigned."]}
Tato odpověď znamená úspěšný průběh importu s jedním varováním. Detaily a statistiky pak lze najít v Quantu.
- Formát exportovaných záznamů
Každý záznam obsahuje následující položky:
Název | Popis | Typ |
Equipment ID | ID vybavení, kterému obrázek patří. | text |
ID | ID obrázku. | text |
Uploaded | Datum nahrání obrázku. | date |
Uploaded By | Uživatel, který nahrál obrázek. | text |
PhotoID | ID ke stažení fotky (viz. návod níže). | text |
Implemented Planogram Id | ID ke stažení obrázku planogramu, ke kterému daná fotka patří (viz. návod níže). Pokud je prázdné, fotka nebyla nahrána jako fotka implementace. | text |
Title | Název obrázku vyplněný uživatelem. | text |
Description | Popis obrázku vyplněný uživatelem. | text |
Stažení fotky vybavení
Pro stažení fotky vybavení použijeme položku PhotoID z vybraného záznamu exportu.
- Požadavek
Parametr | Hodnota |
URL | /downloadImage/<PhotoID> |
Header | Authorization: Bearer <TOKEN> TOKEN se získává pomocí /authenticate (více informací v manuálu REST API Úvod a přihlášení). |
Method | GET |
Požadavek
curl -o image.jpg -H 'Authorization: Bearer i37YKbgCnJSXe2nvIrHA1fE8bLIE4RqROu4l1AOTzHZXSmZ3CX' -G https://[VASE_SPOLECNOST.iquant.eu/downloadImage/105
Odpověď
A binary JPEG image.
Stažení obrázku planogramu
Pro stažení obrázku planogramu použijeme položku Implemented Planogram Id z vybraného záznamu exportu.
- Požadavek
Parametr | Hodnota |
URL | /downloadPlanogramImage/<PlanogramID> |
Header | Authorization: Bearer <TOKEN> TOKEN se získává pomocí /authenticate (více informací v manuálu REST API Úvod a přihlášení). |
Method | GET |
Požadavek
curl -o planogram.jpg -H 'Authorization: Bearer i37YKbgCnJSXe2nvIrHA1fE8bLIE4RqROu4l1AOTzHZXSmZ3CX' -G https://[VASE_SPOLECNOST.iquant.eu/downloadPlanogramImage/96444
Odpověď
Binární obrázek typu JPEG s rozměry, které se vejdou do limitů stanovených v nastavění exportu.