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
PUT /fund/{id}/import

Import dat k AS

Parameters
  • id (string) – Identifikátor AS

Status Codes
DELETE /fund/{id}/structuredObject

Smazání seznamu hodnot strukturovaného datového typu

Parameters
  • id (integer) – Identifikátor AS

Status Codes
  • 200 OK – Seznam smazaných id hodnot strukturovaného datového typu

DELETE /accesspoints/{id}

Zneplatnění přístupového bodu

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

Status Codes
GET /accesspoints/{id}/autoitems

Vrátí seznam automaticky generovaných prvků popisu

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

Status Codes
PUT /accesspoints/{id}/copy

Kopírování archivní entity

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

Status Codes
PUT /accesspoints/{id}/restore

Obnovení neplatné entity a návrat do původního stavu

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

Status Codes
PUT /accesspoints/{id}/validate

Ověřování entity

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

Status Codes
DELETE /accesspoints

Zneplatnění přístupovych bodu

Status Codes
POST /revision/{id}

Vytvoření nové revize přístupového bodu

Parameters
  • id (integer) – Identifikátor archivní entity

Status Codes
DELETE /revision/{id}

Smazání revize přístupového bodu

Parameters
  • id (integer) – Identifikátor archivní entity

Status Codes
POST /revision/{id}/state

Změna stavu revize přístupového bodu

Parameters
  • id (integer) – Identifikátor archivní entity

Status Codes
  • 200 OK – Potvrzení o úspěšné změně stavu revize

  • 404 Not Found – AP nebo revize neexistuje

GET /revision/{id}/autoitems

Vrátí seznam automaticky generovaných prvků popisu pro revizi

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

Status Codes
DELETE /revision/{id}/part/{partId}

Smazání části popisu z revize

Parameters
  • id (integer) – Identifikátor archivní entity

  • partId (integer) – Identifikátor části popisu

Status Codes
  • 200 OK – Potvrzení o úspěšném smažání částí popisu

  • 404 Not Found – AP nebo revize neexistuje

POST /revision/{id}/part/{partId}/prefer-name

Nastavení preferovaného jména

Parameters
  • id (integer) – Identifikátor archivní entity

  • partId (integer) – Identifikátor části popisu

Status Codes
  • 200 OK – Potvrzení o úspěšném nastavení preferovaného jména

  • 404 Not Found – AP nebo revize neexistuje

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
GET /admin/arrangement/missing-cached-nodes

Vytvoření chybějících záznamů v arr_cached_node

Status Codes
  • 200 OK – Potvrzení o úspěšném stvoření