5.6. API (REST)

REST API slouží pro integraci aplikace Elza s dalšími komponentami a informačními systémy. REST API je doplňkem k pokročilejšímu WSDL API.

API je popsáno pomocí OpenAPI definice.

Definice OpenAPI je dostupné na adrese: <ELZA_URL>/swagger-ui/index.html.

5.6.1. Vstupní URL

Rozhraní je dostupné na adrese: <ELZA_URL>/api/v1.

5.6.2. Definice rozhraní

Definice rozhraní REST: elza-openapi.yml

5.6.3. Funkce REST rozhraní

POST /fund

Založené nového archivního souboru

Status Codes

  • 200 OK – Úspěšné založení archivního souboru

  • 400 Bad Request – Neplatné údaje pro založení AS

GET /fund

Vyhledání archivních souborů

Query Parameters

  • fulltext (string) – Vyhledávaný výraz

  • institutionIdentifier (string) – Identifikátor instituce (podpora pro kód instituce i UUID přístupového bodu)

  • max (integer) – Maximální počet výsledků na stránku

  • from (integer) – Od kolikátého záznamu se mají výsledky vracet (0 = žádné se nepřeskočí)

Status Codes

  • 200 OK – Výsledek hledání AS

GET /fund/{id}

Získání detailu AS

Parameters

  • id (string) – Identifikátor AS

Status Codes
PUT /fund/{id}

Změna AS

Parameters

  • id (string) – Identifikátor AS

Status Codes
DELETE /accesspoints/{id}

Zneplatnění přístupového bodu

Parameters

  • id (string) – Identifikátor archivní entity

Status Codes
DELETE /accesspoints

Zneplatnění přístupovych bodu

Status Codes
POST /daos/{id}/change-scenario

Změna scénáře napojení dao

Parameters

  • id (integer) – Identifikátor dao

Status Codes
POST /search-ap

searches for entity

Status Codes
POST /search-arr

searches for entity

Status Codes