REST API

REST API

Zaklad

REST API je dostupne pod cestou:

/rest/v1

Pri standardnim lokalnim nasazeni:

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

Interaktivni dokumentace je dostupna ve Swagger UI:

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

Aplikace

Metoda	Endpoint	Popis
GET	/application	Vrati zakladni informace o aplikaci a verzi DB schematu.
GET	/application/valuemap	Vrati ciselniky a konfiguraci editovatelnych metadat.
GET	/application/clientConfig	Vrati JSON konfiguraci pro klientskou aplikaci.

Priklad:

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

Davky

Metoda	Endpoint	Popis
GET	/batch/folder?parentFolder=	Vrati seznam podslozek dostupnych pro zalozeni davky.
GET	/batch/engines	Vrati seznam Metakat enginu.
GET	/batch	Vrati seznam davek podle filtru.
POST	/batch	Zalozi novou davku a zaradi ji ke zpracovani.
DELETE	/batch	Smaze davky podle zadanych filtru.
POST	/batch/{batchId}/stop	Zastavi zpracovani davky.
POST	/batch/{batchId}/restart	Restartuje zpracovani davky.

Filtry seznamu davek

Parametr	Popis
batchId	ID davky.
state	Stav davky.
folder	Cast cesty ke slozce davky.
log	Cast logu davky.
proarcBatchId	ID davky v ProArc.
createDateFrom, createDateTo	Rozsah data vytvoreni.
updateDateFrom, updateDateTo	Rozsah data posledni zmeny.
_startRow	Offset strankovani.
_size	Pocet zaznamu, vychozi 100, maximum 1000.
_sortBy	Sloupec razeni.
_sort	Smer razeni.

Priklad zalozeni davky:

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=	Vrati objekty v davce.
POST	/object	Oznaci davku jako dokoncene editovanou.
GET	/object/metadata?batchId=&pid=	Vrati metadata konkretniho objektu.
POST	/object/metadata	Aktualizuje metadata konkretniho objektu.
GET	/object/alto?batchId=&pid=	Vrati ALTO XML objektu.
GET	/object/image?batchId=&pid=&typ=	Vrati obraz objektu.

Podporovane hodnoty parametru typ:

Hodnota	Vysledek
original nebo prazdna hodnota	Originalni obraz.
preview	Nahled.
thumbnail	Miniatura.

Priklad nacteni metadat:

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

Priklad ulozeni 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":["Novy nazev"]}'

Stavy davky

Pro cteni objektu a souboru musi byt davka ve stavu:

• GENERATED
• EDITING
• EDITED

Pro editaci metadat musi byt davka ve stavu:

• GENERATED
• EDITING

Po prvni editaci metadat se davka ze stavu GENERATED prepne do stavu EDITING. Po potvrzeni editace endpointem POST /object se metakat.json prejmenuje na metakat_edited.json a stav davky se nastavi na EDITED.