Czech Statistical Office (CZSO) Katalog API

openapi: 3.2.0
info:
  title: Csu Gov Cz Katalog API
  version: 1.28.1
  description: 'Operations tagged Katalog across 2 of this provider''s published API definitions: csu-gov-cz-katalog-api-docs.json, csu-gov-cz-datastat-catalog-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://data.csu.gov.cz/api/katalog/v1
  description: Generated server url
tags:
- name: Katalog
  description: Hierarchický katalog datových sad
paths:
  /polozky/hledani:
    post:
      tags:
      - Katalog
      summary: Vyhledávání položek v katalogu
      operationId: postCatalogSearch
      parameters:
      - name: Accept-Language
        in: header
        description: jazyk pro obsah odpovědi
        required: false
        schema:
          type: string
          default: cs
      - name: jenPosledniVerze
        in: query
        description: Nehledá se ve starších verzích výběrů a sad
        required: false
        schema:
          type: boolean
          default: true
      - name: jenPripravene
        in: query
        description: Vrací jen připravené položky i pro uživatele s oprávněním na položky v libovolném stavu
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FiltrKatalogu'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VysledekHledaniPolozkyKatalogu'
    servers:
    - url: https://data.csu.gov.cz/api/katalog/v1
      description: Generated server url
  /polozky:
    get:
      tags:
      - Katalog
      summary: Struktura katalogu
      operationId: getCatalog
      parameters:
      - name: Accept-Language
        in: header
        description: jazyk pro obsah odpovědi
        required: false
        schema:
          type: string
          default: cs
      - name: jenPripravene
        in: query
        description: Vrací jen připravené položky i pro uživatele s oprávněním na položky v libovolném stavu
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolozkaKatalogu'
    servers:
    - url: https://data.csu.gov.cz/api/katalog/v1
      description: Generated server url
  /polozky/{kodPolozky}:
    get:
      tags:
      - Katalog
      summary: Položka katalogu
      operationId: getCatalogItem
      parameters:
      - name: kodPolozky
        in: path
        description: Kód položky katalogu
        required: true
        schema:
          type: string
      - name: Accept-Language
        in: header
        description: jazyk pro obsah odpovědi
        required: false
        schema:
          type: string
          default: cs
      - name: vicejazycne
        in: query
        description: 'vrátí kompletní vícejazyčné popisy (en+cs ..)  '
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolozkaKatalogu'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolozkaKatalogu'
    servers:
    - url: https://data.csu.gov.cz/api/katalog/v1
      description: Generated server url
components:
  schemas:
    LokalizovanyTextPolozka:
      required:
      - jazyk
      - text
      type: object
      properties:
        jazyk:
          type: string
          description: Kód jazyka dle ISO (dvoupísmenný)
          example: cs
          enum:
          - cs
          - en
        text:
          type: string
          description: Text v jazyce.
          example: Název
      description: Varianta vícejazyčného textu v jednom z jazyků
    LokalizovanePopisy:
      required:
      - nazev
      type: object
      properties:
        nazev:
          type: array
          description: Vícejazyčný text
          items:
            $ref: '#/components/schemas/LokalizovanyTextPolozka'
        zkracenyNazev:
          type: array
          description: Vícejazyčný text
          items:
            $ref: '#/components/schemas/LokalizovanyTextPolozka'
        alternativniNazev:
          type: array
          description: Vícejazyčný text
          items:
            $ref: '#/components/schemas/LokalizovanyTextPolozka'
        popis:
          type: array
          description: Vícejazyčný text
          items:
            $ref: '#/components/schemas/LokalizovanyTextPolozka'
        poznamka:
          type: array
          description: Vícejazyčný text
          items:
            $ref: '#/components/schemas/LokalizovanyTextPolozka'
        toolTip:
          type: array
          description: Vícejazyčný text
          items:
            $ref: '#/components/schemas/LokalizovanyTextPolozka'
        definice:
          type: array
          description: Vícejazyčný text
          items:
            $ref: '#/components/schemas/LokalizovanyTextPolozka'
        interniKomentar:
          type: string
        klicovaSlova:
          type: array
          items:
            type: array
            items:
              $ref: '#/components/schemas/LokalizovanyTextPolozka'
        souvisejiciOdkazy:
          type: array
          items:
            type: array
            items:
              $ref: '#/components/schemas/LokalizovanyOdkazPolozka'
      description: Popisy ve všech jazykových mutacích (cs/en)
    LokalizovanyOdkazPolozka:
      required:
      - jazyk
      - uri
      type: object
      properties:
        jazyk:
          type: string
          description: jazyk odkazované strany
          example: cs
          enum:
          - cs
          - en
        text:
          type: string
          example: Název
        uri:
          type: string
          description: URI odkazované strany
        zdroj:
          type: string
          description: Zdroj odkazu (systémový nebo specifický).
          enum:
          - SYSTEMOVY
          - SPECIFICKY
      description: Varianta vícejazyčného odkazu
    FiltrSlozeny:
      required:
      - polozkyFiltru
      type: object
      properties:
        polozkyFiltru:
          type: array
          description: Položky filtru katalogu
          items:
            $ref: '#/components/schemas/FiltrPodminka'
        vztahPolozek:
          type: string
          description: Typ podmínky ve filtru. Podporována je hodnota "VSE" (ALL), tedy musí platit všechny uvedené podmínky v seznamu současně.
          example: VSE
      description: Více podmínek ve filtru
    Popisy:
      required:
      - nazev
      type: object
      properties:
        nazev:
          type: string
        zkracenyNazev:
          type: string
        alternativniNazev:
          type: string
        popis:
          type: string
        poznamka:
          type: string
        toolTip:
          type: string
        interniKomentar:
          type: string
        klicovaSlova:
          type: array
          items:
            type: string
        souvisejiciOdkazy:
          type: array
          items:
            $ref: '#/components/schemas/OdkazDto'
      description: Popisy v aktuálně požadované lokalizaci (cs/en)
    OdkazDto:
      required:
      - uri
      type: object
      properties:
        text:
          type: string
          example: Název
        uri:
          type: string
          description: URI odkazované strany
        zdroj:
          type: string
          description: Zdroj odkazu (systémový nebo specifický).
          enum:
          - SYSTEMOVY
          - SPECIFICKY
    VysledekHledaniPolozkyKatalogu:
      required:
      - polozky
      - primoNalezene
      type: object
      properties:
        polozky:
          type: array
          description: Položky katalogu ve struktuře totožné jako pro GET metodu
          items:
            $ref: '#/components/schemas/PolozkaKatalogu'
        primoNalezene:
          type: array
          description: Přímo nalezené položky (nezahrnuje podpoložky nalezených položek a nadpoložky nalezených položek/sad/výběrů)
          items:
            $ref: '#/components/schemas/PolozkaKataloguIdentifikace'
        podrobnostiVyhledani:
          type: array
          description: 'Seznam podrobností k nalezeným položkám.  Obsahuje cestu, kterou se nalezená položka vyhledala a zvýraznění nalezených textů (pro textové vyhledávací dotazy) '
          items:
            $ref: '#/components/schemas/VysledekHledaniPodrobnostiPolozka'
      description: 'Vrací výsledek hledání pro položky katalogu.  Výsledek v poli "polozky" vrací i nadřazené položky k vyhledaným položkám, sadám a výběrům a podřízené položky k vyhledaným položkám. Pole "primoNalezene" vrací identifikátory přímo nalezených poduzlů stromu (sad, položek, výběrů). Tyto uzly stromu jsou určeny k automatickému rozbalení ve stromových pohledech '
    FiltrPodminka:
      required:
      - typPodminky
      type: object
      properties:
        typPodminky:
          type: string
          description: 'Typ podmínky ve filtru. Podle nastavení typPodminky se vyplňuje filtrační objekt textoveHledani, nebo vycetNavazanychPolozek '
          enum:
          - TEXTOVE_HLEDANI
          - VYCET_NAVAZANYCH_POLOZEK
          - HODNOTA_POLE
        textoveHledani:
          $ref: '#/components/schemas/FiltrPodminkaText'
        vycetNavazanychPolozek:
          $ref: '#/components/schemas/FiltrPodminkaVycetNavazanych'
        hodnotaPole:
          $ref: '#/components/schemas/FiltrPodminkaHodnotaPole'
      description: Jedna podmínka ve filtru - v objektu je uvedena vždy jedna podmínka podle "typPodminky". K ní musí být zadáno odpovídající pole s podmínkou a jejími parametry.
    VysledekHledaniPodrobnostiCesta:
      type: object
      properties:
        navazanaEntita:
          type: string
          description: Typ navázané entity, přes kterou byla položka nalezena (přímo či nepřímo).
        pole:
          type: string
          description: Pole, přes které se hledalo (pokud není aplikováno hledání ve více polích)
        zvyraznenyText:
          $ref: '#/components/schemas/VysledekHledaniPodrobnostiPole'
      description: Způsob nalezení položky
    PolozkaKatalogu:
      required:
      - kod
      - typ
      type: object
      properties:
        typ:
          type: string
          enum:
          - POLOZKA
          - SADA
          - VYBER
        kod:
          type: string
          description: Unikátní kód položky katalogu v rámci typu položky
        verze:
          pattern: ^([0-9])*(?:\.([0-9])*)*$
          type: string
          description: Číslo verze entity katalogu (sada, výběr, dimenze, ukazatel)
          example: 1.2.0
        nazev:
          type: string
          description: Název pro zobrazení (ve zvoleném jazyce)
        toolTip:
          type: string
          description: Tooltip - pro zobrazení (ve zvoleném jazyce)
        popisy:
          $ref: '#/components/schemas/Popisy'
        lokalizovanePopisy:
          $ref: '#/components/schemas/LokalizovanePopisy'
        stav:
          type: string
          description: Stav sady
          enum:
          - ROZPRACOVANO
          - KONTROLA
          - SCHVALENO
          - ZVEREJNENO
          - ZRUSENO
        zverejnenoOd:
          type: string
          description: Určený čas zveřejnění
          format: date-time
        zverejnenoDo:
          type: string
          description: Určený čas konce zveřejnění
          format: date-time
        casAktualizace:
          type: string
          format: date-time
        poradi:
          type: integer
          description: Pořadí položky ve větvi katalogu
          format: int32
        polozky:
          type: array
          description: Seznam podpoložek s parametry. Podpoložky se mohou vnořovat do libovolného počtu úrovní. Výběry nemají žádné podpoložky
          items:
            $ref: '#/components/schemas/PolozkaKatalogu'
        parametryZobrazeni:
          $ref: '#/components/schemas/PolozkaKataloguParametryZobrazeni'
      description: Položka katalogu. Položka "lokalizovanePopisy" se vrací pouze pokud je nastaven vstupní parametr "vicejazycne=true". Verze je uvedena pouze pro sady a výběry. Položky stromu nejsou verzované. Čas aktualizace reprezentuje aktualizaci metadat, nikoli obsažených dat v sadě. Položky se filtrují podle oprávnění a aktuálního času.
    VysledekHledaniPodrobnostiPolozka:
      required:
      - kod
      - typEntity
      type: object
      properties:
        typEntity:
          type: string
          description: Typ položky. Nutné u výsledků s výce typy položek.
          enum:
          - SADA
          - VYBER
          - POLOZKA_KATALOGU
          - DIMENZE
          - UKAZATEL
          - UROVEN_DIMENZE
        kod:
          type: string
          description: Kód položky
        verze:
          type: string
          description: Verze nalezené položky
        cestaVyhledani:
          type: array
          description: Seznam způsobů nalezení položky
          items:
            $ref: '#/components/schemas/VysledekHledaniPodrobnostiCesta'
      description: 'Podrobnosti k nalezené položce.  Obsahuje cestu, kterou se nalezená položka vyhledala a zvýraznění nalezených textů (pro textové vyhledávací dotazy) '
    FiltrPodminkaVycetNavazanych:
      type: object
      properties:
        entita:
          type: string
          description: Navázaná entita pro níž je předán seznam kódů k vyhledání výsledku. Obsehuje buď identifikátory (potom je výsledek závislý na verzích) nebo kódy (pak se vrací širší výsledek)
          enum:
          - SADA
          - VYBER
          - UKAZATEL
          - DIMENZE
          - POLOZKA_DIMENZE
          - UROVEN_DIMENZE
          - CISELNIK
          - POLOZKA_CISELNIKU
          - POLOZKA_KATALOGU
        identifikatory:
          type: array
          description: Seznam identifikátorů vlastní nebo navázané entity, podle kterých se vrací výsledek
          items:
            type: integer
            description: Seznam identifikátorů vlastní nebo navázané entity, podle kterých se vrací výsledek
            format: int32
        kody:
          type: array
          description: Seznam kódů vlastní nebo navázané entity, podle kterého se vrací výsledek.
          items:
            type: string
            description: Seznam kódů vlastní nebo navázané entity, podle kterého se vrací výsledek.
        vycetZeSeznamu:
          $ref: '#/components/schemas/FiltrPodminkaVycetNavazanychZeSeznamu'
        vztahPolozek:
          type: string
          description: Definuje vztah v podmínce navázaných položek (VSE=dočasně obsahuje, LIBOVOLNE = obsahuje alespoň jeden).
          enum:
          - VSE
          - LIBOVOLNY
      description: Hledá entitu dle výčtu položek z navázaných entit (např. datovou sadu dle položek dimenze)
    FiltrPodminkaVycetNavazanychZeSeznamu:
      type: object
      properties:
        kodyDimenze:
          type: array
          description: Výčet kódu seznamu (např. dimenze), ve kterých jsou položky s kódy nebo identifikátory
          items:
            type: string
            description: Výčet kódu seznamu (např. dimenze), ve kterých jsou položky s kódy nebo identifikátory
      description: kódy v entitě výčtu se omezí na seznamy s uvedeným kódem. Např, kódy položky číselníku POLOZKY_DIMENZE pouze na číselník s uvedeným kódem "DIMENZE". Povolené kombinace budou zadané u každé metody.
    PolozkaKataloguParametryZobrazeni:
      type: object
      properties:
        rozbalit:
          type: boolean
          description: rozbalit větev stromu po načtení
        vysledekHledani:
          type: string
          description: 'Důvod zobrazení ve stromu položek po aplikaci hledání '
          enum:
          - PODPOLOZKA
          - NADPOLOZKA
          - PRIMO
        existujeNovejsi:
          type: string
          description: Existuje novější verze, která ale není nabídnuta ve stromu položek, např. z důvodu že nebyla nalezena při hledání - pole obsahuje číslo novější verze
      description: Parametry pro zobrazení položky, závislé na způsobu hledání položek a existenci verzí a podpoložek ve výběru
    FiltrPodminkaText:
      type: object
      properties:
        text:
          type: string
          description: hledaný text
        navazaneEntity:
          type: array
          description: Výčet dalších navázaných entit pro hledání téhož textu. Pokud není položka uvedena, hledá se jen ve vlastní entitě.
          items:
            $ref: '#/components/schemas/FiltrPodminkaTextNavazanaEntita'
      description: Hledá části zadaného textu v entitě a navázaných entitách, v jednom či více textových polích. (např. sadu dle textu v textu a kódu sady, dimenze, ukazatele)
    FiltrPodminkaHodnotaPole:
      type: object
      properties:
        pole:
          type: string
          description: Kód pole. Každý typ entity může podporovat jiné typy polí. Sada, výběr, dimenze, ukazatel, položka katalogu - VLASTNIK, STAV Dimenze - TYP_DIMENZE Ukazatel - STAPRO
        hodnoty:
          type: array
          description: Hodnoty kterých má pole nabývat (case-insensitive)
          items:
            type: string
            description: Hodnoty kterých má pole nabývat (case-insensitive)
      description: 'Podmínka rovnosti na hodnotu pole. Hodnota pole musí být obsažena v požadovaném výčtu hodnot (IN) '
    PolozkaKataloguIdentifikace:
      required:
      - kod
      - typ
      type: object
      properties:
        typ:
          type: string
          enum:
          - POLOZKA
          - SADA
          - VYBER
        kod:
          type: string
      description: 'Identifikace položky katalogu (typ a kód). '
    VysledekHledaniPodrobnostiPole:
      type: object
      properties:
        pole:
          type: string
          description: Název pole s nalezeným textem
        text:
          type: string
          description: Zvýrazněný nalezený text (highlighting)
      description: Pole s nalezeným textem
    FiltrPodminkaTextNavazanaEntita:
      type: object
      properties:
        entita:
          type: string
          description: Typ navázané entity
          enum:
          - SADA
          - VYBER
          - UKAZATEL
          - DIMENZE
          - POLOZKA_DIMENZE
          - UROVEN_DIMENZE
          - POLOZKA_KATALOGU
          - CISELNIK
        prohledanaPole:
          type: array
          description: Prohledávaná pole. Standardně všechna podporovaná
          items:
            type: string
            description: Prohledávaná pole. Standardně všechna podporovaná
            enum:
            - KOD
            - NAZEV
            - KOMENTAR
      description: NAvázaná entita pro hledání téhož textu. Pokud není položka uvedena, hledá se jen ve vlastní entitě.
    FiltrKatalogu:
      required:
      - podminky
      type: object
      properties:
        podminky:
          $ref: '#/components/schemas/FiltrSlozeny'
        podrobnosti:
          type: string
          description: 'Rozsah vrácených informací. NALEZENE_TEXTY vrací navíc informaci o skutečně vyhledaných textech dle zadané podmínky. '
          enum:
          - JEN_VYSLEDEK
          - PODROBNOSTI
      description: Základní struktura zadání filtru katalogu
x-refined-from:
- csu-gov-cz-katalog-api-docs.json
- csu-gov-cz-datastat-catalog-openapi.yml