.. _batchapi_download:

=============================
Stažení balíčků a souborů
=============================

Pomocí funkcí ``POST /download/aips`` a ``POST /download/files`` v :ref:`REST rozhraní <baseapi>`
je možné vytvářet požadavky na přenos dat z digitálního archivu do návazné aplikace. Následně 
dochází k ověření stavu připravenosti dávky pomocí funkce ``GET /download/status/{batchId}``.
Pokud je dávka s výsledky připravena, může dojít k jejímu přenosu 
pomocí služby :ref:`FileTransfer <batchapi_ft>` do aplikace pro zpracování archiválií.


Parametry přenosu
====================

Parametry přenosu se rozumí údaje, které jsou zapotřebí pro jeho zahájení, tj. pro zahájení pomocí metody 
``Begin``.

 - Typ přenosu: ``download``
 - Doplňující ID: číslo dávky, tj. hodnota ``{batchId}``

Pokud je dávka připravena, je možné zahájit její stahování voláním dalších přenosových metod.


Formát dat
===============

Dávkou se vždy rozumí sada adresářů. Způsob jejich pojmenování a obsah 
je dán původním požadavkem, tj. jeho typem a další parametrizací.
Přehled podob stažených dat je v následující tabulce:

.. list-table::
   :widths: 50 50 50
   :header-rows: 1

   * - Požadavek
     - Parametry
     - Formát dat
   * - ``POST /download/aips``
     - ``dipType="package_info"``
     - :ref:`pkgs_pkginf`
   * - ``POST /download/aips``
     - ``dipType="archdesc"``
     - :ref:`pkgs_archinf`
   * - ``POST /download/aips``
     - ``dipType="metadata_base"``
     - :ref:`pkgs_content`
   * - ``POST /download/aips``
     - ``dipType="aip_base"``
     - :ref:`pkgs_content`
   * - ``POST /download/aips``
     - ``dipType="aip_raw"``
     - dle specifikace digitálního archivu
   * - ``POST /download/files``
     - AIP ID, seznam ID souborů
     - :ref:`pkgs_files`