Kvůli zvýšení rychlosti nejsou implicitně vraceny všechny údaje, které evidujeme. Úroveň detailnosti údajů lze řídit. Tento seznam má význam jen u formátů XML, JSON, XLS a CSV. Další formáty jako je PDF či ISDOC to nijak neovlivňuje. Lze vybrat vždy jen jednu z úrovní.
Úroveň detailu je určena parametrem detail
. Pro výpis seznamu záznamů je výchozí úroveň summary
, pro detail záznamu je to full
.
Ukázka: /c/firma/adresar?detail=summary
Kód | Název | Popis |
| Identifikátor | Jen primární klíč záznamu |
| Přehled | Základní přehled jako je |
| Plný detail | Přehled všech položek, které základní záznam obsahuje. |
| Uživatelský detail | Pouze |
Uživatelská úroveň detailu umožňuje vybrat libovolné položky k zobrazení. Je vhodné, pokud chcete pouze některé údaje, ale summary
neobsahuje to, co potřebujete. Zápis v URL je speciální:
/c/firma/adresar?detail=custom:nazev,ic
Způsobí, že se vyexportuje jen ID, název a IČO. Po řetězci custom
následuje dvojtečka a za ní čárkou oddělený seznam položek, které se mají vyexportovat. Položka id
se exportuje vždy, takže ji není třeba uvádět. Neznámé vlastnosti se ignorují.
Je možné specifikovat uživatelskou úroveň detailu i pro kolekce objektů. Za jméno kolekce stačí uvést seznam vlastností v závorkách, takto:
/c/firma/cenik?detail=custom:kod,sady-a-komplety(cenik,cenikSada)
To znamená, že z ceníku se vyexportuje pouze kód a kolekce sad/kompletů, přičemž pro každou sadu/komplet se vyexportují pouze vlastnosti cenik
a cenikSada
(a samozřejmě ID).
Pokud je potřeba, tento zápis lze i vnořovat (např. /c/abc/cenik.xml?detail=custom:kod,sady-a-komplety(cenik(nazev),cenikSada)&includes=/cenik/sady-a-komplety/sady-a-komplety/cenik
).
Příklad pro infomrace o kontaktní osobě definované na místě určení firmy:
&includes=faktura-vydana/mistUrc/misto-urceni/kontaktOsoba&detail=custom:mistUrc(kontaktOsoba(jmeno,prijmeni,tel,mobil,email))
Kromě základní úrovně detailu lze parametrem relations
řídit i další informace. Ty lze kombinovat oddělením čárkou:
Ukázka: /c/firma/adresar?relations=vazby,prilohy
Pozor: položky, které jsou řízené tímto výpisem, lze pouze exportovat z ABRA Flexi. Nelze je využít pro import do ABRA Flexi. Pro import je nutné vkládat data do samotné tabulky.
Kód | Název | Popis |
| Vazby mezi doklady |
|
| Přílohy |
|
| Skladové karty (u ceníku) |
|
| Položky dokladu |
|
Lze také určit, aby místo pouhého ID ve vazbě se vložil celý objekt.
Ukázka: /c/firma/adresar?includes=/adresar/stat/
Pokud chcete includes aplikovat vícekrát oddělte je čárkou: ?
includes=/adresar/stat/,/adresar/stredisko/