REST API

Základ

REST API je dostupné pod cestou:

/rest/v1

Při standardním lokálním nasazení:

http://localhost:8080/metacheck/rest/v1

Interaktivní dokumentace je dostupná každé instanci ve Swagger UI na adrese níže. Příklad Swagger UI testovací aplikace

http://localhost:8080/metacheck/swagger/

Aplikace

Metoda	Endpoint	Popis
GET	/application	Vrátí základní informace o aplikaci a verzi DB schématu.
GET	/application/valuemap	Vrátí číselníky a konfiguraci editovatelných metadat.
GET	/application/clientConfig	Vrátí JSON konfiguraci pro klientskou aplikaci.

Příklad:

curl http://localhost:8080/metacheck/rest/v1/application

Dávky

Metoda	Endpoint	Popis
GET	/batch/folder?parentFolder=	Vrátí seznam podsložek dostupných pro založení dávky.
GET	/batch/engines	Vrátí seznam Metakat enginů.
GET	/batch	Vrátí seznam dávek podle filtru.
POST	/batch	Založí novou dávku a zařadí ji ke zpracování.
DELETE	/batch	Smaže dávky podle zadaných filtrů.
POST	/batch/{batchId}/stop	Zastaví zpracování dávky.
POST	/batch/{batchId}/restart	Restartuje zpracování dávky.

Filtry seznamu dávek

Parametr	Popis
batchId	ID dávky.
state	Stav dávky.
folder	Část cesty ke složce dávky.
log	Část logu dávky.
proarcBatchId	ID dávky v ProArc.
createDateFrom, createDateTo	Rozsah data vytvoření.
updateDateFrom, updateDateTo	Rozsah data poslední změny.
_startRow	Offset stránkování.
_size	Počet záznamů, výchozí 100, maximum 1000.
_sortBy	Sloupec řazení.
_sort	Směr řazení.

Příklad založení dávky:

curl -X POST http://localhost:8080/metacheck/rest/v1/batch \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data "folder=batch-001" \
  --data "engine=default" \
  --data "proarcBatchId=123"

Objekty a metadata

Metoda	Endpoint	Popis
GET	/object?batchId=	Vrátí objekty v dávce.
POST	/object	Označí dávku jako dokončeně editovanou.
GET	/object/metadata?batchId=&pid=	Vrátí metadata konkrétního objektu.
POST	/object/metadata	Aktualizuje metadata konkrétního objektu.
GET	/object/alto?batchId=&pid=	Vrátí ALTO XML objektu.
GET	/object/image?batchId=&pid=&typ=	Vrátí obraz objektu.

Podporované hodnoty parametru typ:

Hodnota	Výsledek
original nebo prázdná hodnota	Originální obraz.
preview	Náhled.
thumbnail	Miniatura.

Příklad načtení metadat:

curl "http://localhost:8080/metacheck/rest/v1/object/metadata?batchId=1&pid=uuid:example"

Příklad uložení metadat:

curl -X POST http://localhost:8080/metacheck/rest/v1/object/metadata \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data "batchId=1" \
  --data "pid=uuid:example" \
  --data-urlencode 'metadata={"title":["Nový název"]}'

Stavy dávky

Pro čtení objektů a souborů musí být dávka ve stavu:

• GENERATED
• EDITING
• EDITED

Pro editaci metadat musí být dávka ve stavu:

• GENERATED
• EDITING

Po první editaci metadat se dávka ze stavu GENERATED přepne do stavu EDITING. Po potvrzení editace endpointem POST /object se metakat.json přejmenuje na metakat_edited.json a stav dávky se nastaví na EDITED.