Preskoči na glavno vsebino

Používateľské dotazy

Ako pracovať s používateľskými dotazmi cez REST API?

Avtor: Lenka Haringerová

Cez REST API je možné bežným spôsobom pracovať s používateľskými dotazmi:

/c/firma/uzivatelsky-dotaz

Okrem toho je možné používateľský dotaz aj zavolať.

Najjednoduchší dotaz, t. j. taký, ktorý nemá parametre (alebo majú všetky parametre postačujúce predvolené hodnoty), možno zavolať takto:

/c/firma/uzivatelsky-dotaz/1/call.xml (možné aj .json).

Kde "/1" zodpovedá ID daného používateľského dotazu.

Fungujú bežné parametre pre úroveň detailu alebo stránkovanie.

Ak má dotaz parametre, je potrebné pre každý parameter dotazu uviesť parameter v URL. T. j. napr. ak má dotaz parameter datum, jeho volanie vyzerá takto: /c/firma/uzivatelsky-dotaz/1/call.xml?datum=2012-01-01.

Ak má parameter dotazu mohutnosť N, t. j. možno zadať viac hodnôt, stačí parameter v URL zopakovať. Napr. pre výber niekoľkých firiem:

/c/firma/uzivatelsky-dotaz/1/call.xml?firma=code:FIRMA1&firma=code:FIRMA2.

V uloženom dotaze potom použite operátor IN (<<firma>>).

Hodnoty parametrov sa zapisujú bežným spôsobom, neuzatvárajú sa do úvodzoviek. Nezabudnite na správne kódovanie v URL.

Na volanie dotazu možno okrem metódy GET použiť aj metódu POST, ktorá umožňuje odovzdať aj veľký počet parametrov v tele požiadavky.

Uložené dotazy možno aj tlačiť. Je potrebné pre každý uložený dotaz vytvoriť vlastnú tlač a pri uloženom dotaze ju vybrať. Tlač možno potom volať aj cez REST API.

Ste s tem dobili odgovor na svoje vprašanje?