Kvôli zvýšeniu rýchlosti nie sú implicitne vracané všetky údaje, ktoré evidujeme. Úroveň detailnosti údajov je možné riadiť. Tento zoznam má význam len pri formátoch XML, JSON, XLS a CSV. Ďalšie formáty ako PDF či ISDOC to nijako neovplyvňuje. Vždy je možné vybrať iba jednu z úrovní.
Úroveň detailu je určená parametrom detail. Pre výpis zoznamu záznamov je predvolená úroveň summary, pre detail záznamu je to full.
Ukážka: /c/firma/adresar?detail=summary
Kód | Názov | Popis |
| Identifikátor | Len primárny kľúč záznamu |
| Prehľad | Základný prehľad ako je |
| Plný detail | Prehľad všetkých položiek, ktoré základný záznam obsahuje. |
| Používateľský detail | Iba |
Používateľská úroveň detailu
Používateľská úroveň detailu umožňuje vybrať ľubovoľné položky na zobrazenie. Je vhodná, ak chcete iba niektoré údaje, ale summary neobsahuje to, čo potrebujete. Zápis v URL je špeciálny:
/c/firma/adresar?detail=custom:nazev,ic
Spôsobí, že sa vyexportuje len ID, názov a IČO. Za reťazcom custom nasleduje dvojbodka a za ňou čiarkou oddelený zoznam položiek, ktoré sa majú vyexportovať. Položka id sa exportuje vždy, takže ju nie je potrebné uvádzať. Neznáme vlastnosti sa ignorujú.
💡 detail=custom:… je najrýchlejšia varianta — z databázy sa nenačítavajú objekty, ktoré neuvediete, takže odpadne mnoho SQL dotazov a zmenší sa odpoveď.
Vnorené kolekcie
Je možné špecifikovať používateľskú úroveň detailu aj pre kolekcie objektov. Za názov kolekcie stačí uviesť zoznam vlastností v zátvorkách, takto:
/c/firma/cenik?detail=custom:kod,sady-a-komplety(cenik,cenikSada)
To znamená, že z cenníka sa vyexportuje iba kód a kolekcia sád/kompletov, pričom pre každú sadu/komplet sa vyexportujú iba vlastnosti cenik a cenikSada (a samozrejme ID).
Ak je to potrebné, tento zápis je možné aj vnárať:
/c/abc/cenik.xml?detail=custom:kod,sady-a-komplety(cenik(nazev),cenikSada)&includes=/cenik/sady-a-komplety/sady-a-komplety/cenik
Príklad pre informácie o kontaktnej osobe definovanej na mieste určenia firmy:
&includes=faktura-vydana/mistUrc/misto-urceni/kontaktOsoba&detail=custom:mistUrc(kontaktOsoba(jmeno,prijmeni,tel,mobil,email))
Parameter relations
Okrem základnej úrovne detailu je možné parametrom relations riadiť aj ďalšie informácie. Tie je možné kombinovať oddelením čiarkou.
Ukážka: /c/firma/adresar?relations=vazby,prilohy
Kód | Názov |
| Väzby medzi dokladmi |
| Prílohy |
| Skladové karty (pri cenníku) |
| Položky dokladu |
⚠️ Položky, ktoré sú riadené týmto výpisom, je možné iba exportovať z ABRA Flexi. Nie je možné ich využiť na import do ABRA Flexi. Pre import je nutné vkladať dáta priamo do samotnej tabuľky.
Parameter includes
Je tiež možné určiť, aby sa namiesto samotného ID vo väzbe vložil celý objekt.
/c/firma/adresar?includes=/adresar/stat/
Ak chcete includes aplikovať viackrát, oddeľte ich čiarkou:
/c/firma/adresar?includes=/adresar/stat/,/adresar/stredisko/