API v7

Admin API

/api/admin/v7.0

Procesy

/api/admin/v7.0/processes

• GET /api/admin/v7.0/processes/owners
  • vrátí všechny uživatele, kteří spustili nejaký proces
• GET /api/admin/v7.0/processes/by_process_id/{process_id}
  • vrátí informace o procesu a dávce, která jej obsahuje
• GET /api/admin/v7.0/processes/batches
  • vrátí všechny dávky procesů, včetně těch, které obsahují jediný proces
  • dávky lze filtrovat podle vlastníka, timestampu (od-do), stavu dávky
• GET /api/admin/v7.0/processes/by_process_uuid/{process_uuid}/logs/out
  • vrátí celý standardní log procesu
• GET /api/admin/v7.0/processes/by_process_uuid/{process_uuid}/logs/err
  • vrátí celý chybový log procesu
• GET /api/admin/v7.0/processes/by_process_uuid/{process_uuid}/logs/out/lines
  • vrátí vybrané řádky standardního logu procesu v JSON
  • ?offset=0&limit=100
• GET /api/admin/v7.0/processes/by_process_uuid/{process_uuid}/logs/err/lines
  • vrátí vybrané řádky chybového logu procesu v JSON
  • ?offset=0&limit=100
• POST /api/admin/v7.0/processes
  • naplánuje nový proces
  • v těle očekává JSON definující proces (typ, parametry)
  • nepovinný query parametr batch_token
    • pokud je přítomen, nový proces se zařadí do dávky procesů definované tokenem
• DELETE /api/admin/v7.0/processes/batches/by_first_process_id/{process_id}
  • smaže nejen proces, ale celou dávku, která ho obsahuje TODO: mazání procesů, nejen celých dávek

Sbírky

/api/admin/v7.0/collections

• POST /api/admin/v7.0/collections
  • vytvoří novou sbírku
  • v těle očekává JSON objekt s property name, description, content, standalone
• GET /api/admin/v7.0/collections/{pid}
  • vrátí sbírku podle jejího PID
• GET /api/admin/v7.0/collections/
  • vrátí všechny sbírky
  • query parametr ?withItem={pid} omezí na sbírky přímo obsahující objekt
• PUT /api/admin/v7.0/collections/{pid}
  • aktualizuje záznam sbírky (name, description, content, standalone)
• POST /api/admin/v7.0/collections/{pid}/items
  • přidá položku do sbírky
  • tělo obsahuje PID objektu, který je do sbírky přidáván
• DELETE /api/admin/v7.0/collections/{pid}/items/{item-pid}
  • odebere položku ze sbírky
• DELETE /api/admin/v7.0/collections/{pid}
  • odstraní sbírku

Objekty v repozitáři

/api/admin/v7.0/items

• GET /api/admin/v7.0/items?model={model}
  • seznam všech objektů podle modelu (pid, title)
  • seřazeno podle dc.title, nepovinný parametr &sort=ASC/DESC
  • nepovinný parametry offset, limit, případně cursor. Pokud je cursor přítomen, ignoruje se offset
• GET /api/admin/v7.0/items/{pid}/foxml
• HEAD/GET /api/admin/v7.0/items/{pid}/streams/{dsid}
• PUT /api/admin/v7.0/items/{pid}/streams/BIBLIO_MODS
  • nastaví MODS záznam objektu
• GET /api/admin/v7.0/items/{pid}/streams/{dsid}/mime
• PUT /api/admin/v7.0/items/{pid}/streams/IMG_THUMB?srcPid={srcPid}
  • zkopíruje celý ds IMG_THUMB z foxml objektu {srcPid}. {pid} nesmí být stránka, {srcPid} musí být stránka
  • pro nastavení reprezentativní strany

Konfigurace

/api/admin/v7.0/config

• GET /api/admin/v7.0/{key}
  • získání hodnoty obecné property podle klíče

Client API

/api/client/v7.0

Vyhledávání

/api/client/v7.0/search

• GET /api/client/v7.0/search
  • vyhledávání
• GET /api/client/v7.0/search/terms
  • vrací hodnoty a počty výskytů pro vybrané pole

Info

/api/client/v7.0/info

• GET /api/client/v7.0/info[?language={lang}]
  • informace o verzi, textová zpráva o nedostupnosti, max. počtu stránek pro generování pdf, atd.

Objekty v repozitáři

/api/client/v7.0/items

• info
  • GET /api/client/v7.0/items/{pid}/info
  • GET /api/client/v7.0/items/{pid}/info/data
  • GET /api/client/v7.0/items/{pid}/info/structure
  • GET /api/client/v7.0/items/{pid}/info/image
  • GET /api/client/v7.0/items/{pid}/info/providedByLicenses
• metadata
  • HEAD/GET /api/client/v7.0/items/{pid}/metadata/mods
  • HEAD/GET /api/client/v7.0/items/{pid}/metadata/dc
• ocr
  • HEAD/GET /api/client/v7.0/items/{pid}/ocr/text
  • HEAD/GET /api/client/v7.0/items/{pid}/ocr/alto
• obrázky
  • HEAD/GET /api/client/v7.0/items/{pid}/image
    • obsah datastreamu IMG_FULL objektu samotného
  • GET /api/client/v7.0/items/{pid}/image/thumb
    • první dostupný obrázek thumbnail - objektu samotného, nebo některého jeho potomka
  • GET /api/client/v7.0/items/{pid}/image/preview
    • první dostupný obrázek preview - objektu samotného, nebo některého jeho potomka
• zvuky
  • HEAD/GET /api/client/v7.0/items/{pid}/audio/mp3
  • HEAD/GET /api/client/v7.0/items/{pid}/audio/ogg
  • HEAD/GET /api/client/v7.0/items/{pid}/audio/wav