4.5. Výběr API

Modul Výběr poskytuje integračních rozhraní umožňující:

  • přidání průvodních dokumentů ke stávajícím archivním entitám (AS, VNěZ, VNiZ, AP) - viz V5 (URL) Zahájení přidávání dokumentů

  • přidání souborů k archiváliím/evidenčním jednotkám

  • vnitřní změna - obohacení archiválií

  • vnitřní změna - dohledání se vznikem archiválií

4.5.1. Definice WSDL rozhraní

Definice rozhraní WSDL: vyber-service-202002.wsdl

4.5.2. V1 (WSDL) Založení změny AIPů

Ve Výběru je možné iniciovat WSDL voláním vznik změny AIPů.

ZalozZmenuAipu(idAS, uživatel, vstupní balíčky)

Funkce umožňující založení řízení daného typu.

Parametry:

  • idAS – číslo archivního souboru

  • uživatel – uživatel primárně zpracovávající požadavek

  • vstupní_balíčky – ID AIPů, které budou obohaceny

Z ESM se volání používá pro tyto typy změn:

  • starou digitalizaci (nahrání digitalizátů a metadat k existujícím prázdným záznamům archiválie)

  • novou digitalizace (nahrání digitalizátů, případně metadat k existujícím záznamům archiválie u nichž jsou již metadata vyplněna v ESM)

  • update obsahových verrzí souborů a nahrání formátových reprezentací

4.5.3. V2 (WSDL) Zahájení Uložení

ZahajeniUlozeni(id, vysledekUlozeni, casti)
Parametry:

  • id – id přejímky v modulu výběr

  • vysledekUlozeni – výsledek první fáze uložení (OK, ERROR)

  • casti – seznam částí přejímky a přidělených identifikátorů změn

class UkládanáČástPřejímky
cisloNad

identifikátor AS

jmenoAs

jméno AS

vnezId:

identifikátor VněZ

4.5.4. V3 (WSDL) Výsledek Uložení Přejimky

VysledekUlozeniPrejimky(id, vysledekUlozeni, aipsIds)
Parametry:

  • id – id přejímky v modulu výběr

  • vysledekUlozeni – OK, ERROR

  • aipsIds – přidělené identifikátory AIPů, jedná se o mapu název adresáře části přejímky/název adresáře SIPu -> AIP ID

4.5.5. V4 (WSDL) Výsledek uložení průvodních dokumentů

VysledekUlozeniPruvodnichDoukmentu(id, vysledekUlozeni)
param id:

id přejímky v modulu výběr

param vysledekUlozeni:

OK, ERROR

4.5.6. V5 (URL) Zahájení přidávání dokumentů

Přístupem na URL: …/vyber/vytvor?id=<ID archivní entity>&typ=<AS/AP/VniZ/VneZ> dojde k zahájení přidávání dokumentů k dané archivní entitě. Voláním této funkce je možné přidávat soubory k archivním entitám AS, VNěZ, VNiZ, AP.

Stránka provede vyžádání metadat archivní entity z ESM. Vytvoří příslušné přidávání a zobrazí jeho uživatelské rozhraní.

4.5.7. V6 (URL) Zobrazení zvoleného výběru

Přístupem na URL: …/vyber/vyber?id=<ID vyberu> dojde k zobrazení příslušného výběru v modulu.