3.8. REST API v2
REST API umožňuje efektivní přístup k jednotlivým funkcím přímo z webové aplikace nebo ze serverových aplikací.
3.8.1. Definice REST rozhraní
Definice rozhraní REST: cam-openapi-v2.yml
3.8.2. Funkce REST rozhraní
- POST /batches
Zaslání dávky se seznamem změn a nových záznamů entit.
Metoda provede synchronně validaci požadavku dle schématu a ověření, že dávka již nebyla zpracována. Následně vrací zpět identifikátor požadavku na změnu, který odpovídá ID zaslané dávky.
- Query Parameters:
force (boolean) – Volitelný atribut pro vynucení zápisu dávky i když existují varování. Pro použití příznaku je nutné mít odpovídající oprávnění.
forceKey (string) –
Volitelný atribut pro vynucení zápisu dávky i když existují varování.
Hodnota klíče je předána v odpovědi na neúspěšný pokus o uložení dávky.
- Status Codes:
200 OK – The request has succeeded.
403 Forbidden – Nedostatečná oprávnění pro provedení požadované změny
409 Conflict – Aktualizační dávka již existuje
500 Internal Server Error – Server error
- POST /batches/test
Zaslání testovací dávky se seznamem změn a nových záznamů entit.
Metoda provede validaci požadavku dle schématu a ověření, že dávka již nebyla zpracována. Následně dojde k zpracování dávky ovšem bez reálného zápisu do databáze.
Metoda je synchronní. V případě příliš velkého množství změn může být vrácena chyba a ověření neproběhne.
- Status Codes:
200 OK – Výsledek zpracování aktualizační dávky
403 Forbidden – Nedostatečná oprávnění pro provedení požadované změny
409 Conflict – Aktualizační dávka již existuje
500 Internal Server Error – Server error
- GET /batches/{updateRequestId}/result
Vrátí výsledek zpracování dávky
- Parameters:
updateRequestId (string)
- Status Codes:
102 Processing – Informational
200 OK – Výsledek zpracování aktualizační dávky
403 Forbidden – Nedostatečná oprávnění pro provedení požadované změny
404 Not Found – Aktualizační dávka nebyla nalezena.
500 Internal Server Error – Server error
- GET /batches/{updateRequestId}/status
Vrátí aktuální stav zpracování změnového požadavku.
- Parameters:
updateRequestId (string)
- Status Codes:
200 OK – The request has succeeded.
403 Forbidden – Nedostatečná oprávnění pro provedení požadované změny
404 Not Found – Aktualizační dávka nebyla nalezena.
500 Internal Server Error – Server error
- GET /entities/{entityId}
Vrátí aktuální podobu záznamu entity
- Parameters:
entityId (string) – ID přístupového bodu (uvádí se číselný identifikátor nebo UUID)
- Status Codes:
200 OK – Úspěšné nalezení záznamu entity.
404 Not Found – Informace o nenalezení požadované entity
- GET /entities/{entityId}/revision/{revisionId}
Vrátí podobu záznamu entity v dané revizi
- Parameters:
entityId (string) – ID přístupového bodu (uvádí se číselný identifikátor nebo UUID)
revisionId (string) – UUID revize, která je požadována
- Status Codes:
200 OK – Úspěšné nalezení záznamu entity.
404 Not Found – Informace o nenalezení požadované entity
- GET /export/download/{id}
Stáhne data exportu
- Parameters:
id (string)
- Status Codes:
102 Processing – Informational
200 OK – The request has succeeded.
404 Not Found – The server cannot find the requested resource.
500 Internal Server Error – Server error
- POST /export/revisions
Vrátí revize záznamů entit
Metoda je asynchronní, vrací se pouze informace o zahájení operace. Výsledek je zapotřebí získat pomocí operace getExportStatus, resp. downloadExport.
Výsledkem operace je stažení XML souboru obsahujícího seznam záznamů dle schématu http://cam.tacr.cz/2025 s kořenovým elementem <entityReocrdRevisions>. XML obsahuje seznam změn v záznamech entit, neobsahuje úplné záznamy entit.
- Query Parameters:
fromTransId (string) – Změny po této transakci budou vráceny. (Required)
- Status Codes:
200 OK – The request has succeeded.
- POST /export/snapshots
Vrátí aktuální podobu požadovaných záznamů entit.
Metoda je asynchronní, vrací se pouze informace o zahájení operace. Výsledek je zapotřebí získat pomocí operace getExportStatus, resp. downloadExport.
Výsledkem operace je stažení XML souboru obsahujícího seznam záznamů dle schématu http://cam.tacr.cz/2025 s kořenovým elementem <entities>.
- Status Codes:
200 OK – The request has succeeded.
- GET /export/status/{id}
Vrátí aktuální stav požadavku na export entit.
- Parameters:
id (string)
- Status Codes:
200 OK – The request has succeeded.
404 Not Found – The server cannot find the requested resource.
500 Internal Server Error – Server error
- POST /search
Vyhledání entit.
- Query Parameters:
page (integer) – číslo stránky (Required)
pageSize (integer) – Velikost stránky, počet záznamů na stránku (Required)
searchType (string) – Typ vyhledávání
- Status Codes:
200 OK – Seznam nalezených záznamů, vrací se stručná informace
- GET /updates
Vrátí stránkovaný seznam aktualizovaných záznamů entit mezi dvěma transakcemi.
- Query Parameters:
fromTransId (string) – ID transakce po níž budou vráceny provedené aktualizace (Required)
toTransId (string) – ID transakce do níž (včetně) budou vráceny provedené aktualizace (Required)
page (integer) – číslo stránky (Required)
pageSize (integer) –
Velikost stránky, počet záznamů na stránku
Maxmimální hodnota je 50000 (Required)
- Status Codes:
200 OK – Seznam změněných záznamů entit.
404 Not Found – Transakce neexistuje
- GET /updates/from/{fromTransId}
Vrátí seznam aktualizovaných záznamů entit po té co daná transakce byla zapsána. Pokud je aktualizací příliš mnoho, tak je nutné použít funkci /updates pro jejich načtění.
- Parameters:
fromTransId (string)
- Status Codes:
200 OK – Seznam změněných záznamů entit.
404 Not Found – Transakce neexistuje