Preskoči na glavno vsebino

Úrovne detailu

Úrovne podrobnosti vrátených údajov

Avtor: Petr Pech

Z dôvodu zvýšenia rýchlosti nie sú implicitne vrátené všetky údaje, ktoré evidujeme. Úroveň podrobnosti údajov možno 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 možno vybrať len 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

id

Identifikátor

Len primárny kľúč záznamu id a externé identifikátory

summary

Prehľad

Základný prehľad ako je id, lastUpdate, kod alebo nazev.

full

Plný detail

Prehľad všetkých položiek, ktoré základný záznam obsahuje.

custom:...

Používateľský detail

Iba id a vymenované položky (pozri nižšie).

Používateľská úroveň detailu umožňuje vybrať ľubovoľné položky na zobrazenie. Je vhodná, ak chcete len 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 exportuje len ID, názov a IČO. Za reťazcom custom nasleduje dvojbodka a za ňou čiarkou oddelený zoznam položiek, ktoré sa majú exportovať. Položka id sa exportuje vždy, takže ju nie je potrebné uvádzať. Neznáme vlastnosti sa ignorujú.

Je možné špecifikovať používateľskú úroveň detailu aj pre kolekcie objektov. Za názvom 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 exportuje iba kód a kolekcia sád/kompletov, pričom pre každú sadu/komplet sa exportujú iba vlastnosti cenik a cenikSada (a samozrejme ID).

Ak je to potrebné, tento zápis možno aj vnárať (napr. /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))

Okrem základnej úrovne detailu možno parametrom relations riadiť aj ďalšie informácie. Tie možno kombinovať oddelením čiarkou:

Ukážka: /c/firma/adresar?relations=vazby,prilohy

Pozor: položky, ktoré sú riadené týmto výpisom, možno 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 príslušnej tabuľky.

Kód

Názov

Popis

vazby

Väzby medzi dokladmi

prilohy

Prílohy

sklad-karty

Skladové karty (pri cenníku)

polozky

Položky dokladu

Možno tiež určiť, aby sa namiesto samotného ID vo väzbe vložil celý objekt.

Ukážka: /c/firma/adresar?includes=/adresar/stat/

Ak chcete includes aplikovať viackrát, oddeľte ich čiarkou: ?

includes=/adresar/stat/,/adresar/stredisko/

Ste s tem dobili odgovor na svoje vprašanje?