3.3. Poskytování entit

API disponuje funkcemi pro poskytnutí jednoho nebo více záznamů entit současně. Záznamy entit jsou přístupné na základě jejich identifikátoru.

Jednotlivá entita je dostupná pomocí funkce /entities/{id}.

3.3.1. Exportní API

Exportní funkce (viz /export… v definici REST API) umožňují hromadné vyžádání více entit. Záznamy o entitách je možné vyžádat v aktuální podobě nebo formou změnových operací od určité transakce v systému. Změnové API je určeno pro systémy, které průběžně udržují synchronizovanou podobu záznamu entity. Se znalostí čísla poslední transakce je možné minimalizovat datový přenos a současně zreplikovat provedené změny.

3.3.2. Změny entit

Systémy, které u sebe udržují vlastní kopii záznamu entity potřebují mít k dispozici informaci o jejich změnách. Změny v systému probíhají formou transakcí. Se znalostí čísla transakce je možné požádat o seznam změn v systému od tohoto čísla dále. Pro získání seznamu změn slouží funkce v části /updates....

Základem je funkce pro vyžádání všech změn od poslední známé transakce (/updates/from/{fromTransId}). Pokud je změn v systému relativně málo, tak je rovnou tato funkce vrátí a to včetně nového čísla poslední transakce. V případě většího množství změn je možné použít stránkovanou funkci (stránkováno od 1) pro jejich vyžádání a synchronizaci (/updates).

V systému je pevně definována prvotní transakce, od které je možné načítat všechny změny od počátku. Identifikace transkace je „91812cb8-3519-4f78-b0ec-df6e951e2c7c“.