Napojeni na MetacheckAPI

Přehled

MetaCheckClient komunikuje s backendem přes REST API MetacheckAPI. Všechna volání jsou skládána nad base URL METACHECK_API_BASE_URL.

Klient je tenká webová vrstva. Stav zpracování, metadata, ALTO XML, obrazová data i seznam importních složek poskytuje backend.

Používané endpointy

Funkce	Metoda	Endpoint	Poznámka
Informace o aplikaci	GET	/application	Název, verze, databáze a stav backendu.
Seznam dávek	GET	/batch	Filtry, stránkování a řazení.
Přidání dávky	POST	/batch	Formulářové pole folder, volitelně proarcBatchId.
Smazání dávek	DELETE	/batch	Podle batchId, state nebo proarcBatchId.
Seznam složek	GET	/batch/folder	Parametr parentFolder.
Dostupné enginy	GET	/batch/engines	Výběr při importu dávky.
Zastavení dávky	POST	/batch/stop	Formulářové pole batchId.
Restart dávky	POST	/batch/restart	Formulářové pole batchId.
Objekty dávky	GET	/object	Parametr batchId.
Metadata objektu	GET	/object/metadata	Parametry batchId, pid.
Uložení metadat	POST	/object/metadata	Formulářové pole metadata obsahuje JSON.
ALTO XML	GET	/object/alto	Parametry batchId, pid.
Obraz objektu	GET	/object/image	Parametry batchId, pid; pro miniaturu typ=thumbnail.

Seznam dávek

Klient podporuje tyto filtry:

Parametr	Popis
batchId	ID dávky.
state	Stav dávky.
folder	Cesta dávky.
log	Text v logu.
proarcBatchId	ID dávky v ProArc.
_startRow	Začátek stránky.
_size	Velikost stránky.
_sortBy	Sloupec řazení.
_sort	asc nebo desc.

Výchozí řazení v klientovi:

createDate desc

Import dávky

Stránka /import načítá kořenové složky voláním:

GET /batch/folder

Při rozbalení složky se volá:

GET /batch/folder?parentFolder={path}

Po výběru složky klient založí dávku:

POST /batch
Content-Type: application/x-www-form-urlencoded

folder={path}

Klient zobrazuje také dostupné enginy:

GET /batch/engines

Poznámka: aktuální klient sice drží vybraný engine ve formuláři, ale do POST /batch odesílá jen folder a proarcBatchId. Pokud má backend podporovat výběr enginu z klienta, je třeba doplnit odeslání pole engine.

Detail dávky

Detail dávky se otevírá na route:

/batches/{batchId}

Po otevření klient načte:

GET /batch?batchId={batchId}&_size=1
GET /object?batchId={batchId}

Po výběru objektu načte metadata a obraz:

GET /object/metadata?batchId={batchId}&pid={uuid}
GET /object/image?batchId={batchId}&pid={uuid}

Miniatury v obrazovém přehledu používají:

GET /object/image?typ=thumbnail&batchId={batchId}&pid={uuid}

Editace metadat

Metadata objektu mají strukturu:

{
  "uuid": "uuid",
  "model": "page",
  "elementsInfoResponse": [
    {
      "field": "pageNumber",
      "originalValue": "1",
      "editedValue": "1",
      "percentage": "0.98"
    }
  ]
}

Uložení probíhá jako formulářový POST:

POST /object/metadata
Content-Type: application/x-www-form-urlencoded

batchId=1&pid=uuid&metadata={json}

Po úspěšném uložení klient znovu načte seznam objektů, aby se projevily změny procent a zobrazovaných hodnot.

ALTO XML

Klient má připravenou metodu:

GET /object/alto?batchId={batchId}&pid={uuid}

Tento endpoint vrací ALTO XML jako text. Aktuální klient má volání připravené na úrovni API služby; případné uživatelské otevření nebo editace ALTO je navazující funkcionalita klienta.

Chybové stavy

Klient preferuje text chyby vracený backendem. Pokud odpověď není textová, zobrazí standardní HttpErrorResponse.message.

Provoz je proto čitelnější, pokud MetacheckAPI vrací při validačních a zpracovatelských chybách srozumitelný textový popis.