Uživatelské dotazy

Jak pracovat s uživatelskými dotazy přes REST API?

Lenka Haringerová avatar
Autor: Lenka Haringerová
Aktualizováno před více než týdnem

Přes REST API lze běžným způsobem pracovat s uživatelskými dotazy:

/c/firma/uzivatelsky-dotaz

Kromě toho je možné uživatelský dotaz také zavolat.

Nejjednodušší dotaz, tj. ten, který nemá parametry (nebo mají všechny parametry postačující výchozí hodnoty), lze zavolat takto:

/c/firma/uzivatelsky-dotaz/1/call.xml (lze i .json).

Kdy "/1" odpovídá ID daného uživatelského dotazu.

Fungují obvyklé parametry pro úroveň detailu nebo stránkování.

Pokud má dotaz parametry, je potřeba pro každý parametr dotazu uvést parametr v URL. Tj. např. pokud má dotaz parametr datum, jeho volání vypadá takto: /c/firma/uzivatelsky-dotaz/1/call.xml?datum=2012-01-01.

Pokud má parametr dotazu mohutnost N, tj. lze zadat více hodnot, stačí parametr v URL zopakovat. Např. pro výběr několika firem:

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

V uloženém dotazu pak použijte operátor IN (<<firma>>).

Hodnoty parametrů se zapisují obvyklým způsobem, neuzavírají se do uvozovek. Nezapomeňte na správné zakódování v URL.

Pro zavolání dotazu lze použít kromě GET metody i metodu POST, která umožňuje předat i velký počet parametrů v těle požadavku.

Uložené dotazy lze i tisknout. Je nutné pro každý uložený dotaz vytvořit vlastní tisk a u uloženého dotazu jej vybrat. Tisk lze pak volat i přes REST API.

Dostali jste odpověď na svou otázku?