3.6. REST API

REST API umožňuje efektivní přístup k jednotlivým funkcím přímo z webové aplikace nebo ze serverových aplikací.

3.6.1. Definice REST rozhraní

Definice rozhraní REST: cam-openapi.yml

3.6.2. Funkce REST rozhraní

GET /entities/{apid}

Vrátí aktuální podobu záznamu entity

Parameters:

  • apid (string) – ID přístupového bodu (uvádí se číselný identifikátor nebo UUID)

Status Codes:

  • 200 OK – Úspěšné nalezení záznamu entity.

POST /export/snapshots

Vrátí aktuální podobu požadovaných záznamů entit

Status Codes:

  • 200 OK – Seznam nalezených záznamů entit.

POST /export/revisions

Vrátí revize záznamů entit

Query Parameters:

  • fromTransId (string) – Změny po této transakci budou vráceny. (Required)

Status Codes:
POST /batches

Zaslání dávky se seznamem změn a nových záznamů entit

Status Codes:

  • 200 OK – XML s výsledkem provedených operací.

  • 403 Forbidden – Nedostatečná oprávnění pro provedení požadované změny

  • 409 Conflict – Dávka již existuje

GET /batches/{bid}/response

Vrátí stav zpracování dávky

Parameters:

  • bid (string) – ID dávky

Status Codes:

  • 102 Processing – Dávka byla přijata, ale doposud není dokončeno její zpracování

  • 200 OK – XML s výsledkem provedených operací.

  • 404 Not Found – Batch does not exists

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/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) – ID transakce po níž budou vráceny provedené aktualizace

Status Codes:
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 (Required)

Status Codes:

  • 200 OK – Seznam změněných záznamů entit.