Přeskočit na hlavní obsah

Řazení záznamů

Jak řadit záznamy v REST API

Autor: Petr Pech

Záznamy lze samozřejmě řadit. Seznam hodnot, podle kterých lze řadit, je závislé na konkrétní evidenci.

Řazení je řízeno parametrem URL order. Tento parameter lze uvést opakovaně.

Ukázka: /c/firma/adresar?order=nazev


Směr řazení

Lze řídit, zda řadit vzestupně (order=nazev@A) nebo sestupně (order=nazev@D).

⚠️ @A znamená vzestupně (ascending), @D sestupně (descending). Bez přípony se řadí vzestupně.

Ukázky:

  • /c/firma/adresar?order=nazev — seřazení adresáře podle vlastnosti nazev vzestupně

  • /c/firma/adresar?order=nazev@D — sestupné řazení

Kvůli kompatibilitě s některými implementacemi, lze také použít parametr sort a dir (nabývá hodnot ASC a DESC).


Řazení podle relačních vlastností

API umožňuje řazení podle relačních vlastností, ale pouze v 1. úrovni. Lze zadat například ?order=stredisko.nazev nebo ?order=stat.kod. Uvedete-li jen název relace (?order=stat), použije se výchozí řazení dané relace.

ℹ️ Zanoření do druhé úrovně (např. ?order=typDokl.radaPrijem.kod) podporováno není a skončí chybou 400 s hlášením, že vlastnost neexistuje.


Výchozí řazení

Pokud parametr order není uveden, řadí se záznamy podle ID. Některé evidence mají výjimku a řadí se ještě podle dalších vlastností — u dokladů podle datVyst, u měnových kurzů podle platiOdData a mena.

Dostali jste odpověď na svou otázku?