Czech Statistical Office (CZSO) Velikosti API

openapi: 3.2.0
info:
  title: Csu Gov Cz Velikosti API
  version: 1.14.4
  description: 'Operations tagged Velikosti across 2 of this provider''s published API definitions: csu-gov-cz-dotaz-api-docs.json, csu-gov-cz-datastat-query-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://data.csu.gov.cz/api/dotaz/v1
  description: Generated server url
tags:
- name: Velikosti
  description: Vrací informaci o předpokládaném rozsahu výsledku dotazu a možnosti stažení dat v jednotlivých formátech s ohledem na poskytovatelem stanovené limity.
paths:
  /velikosti/sady/{sadaKod}/vlastni:
    post:
      tags:
      - Velikosti
      summary: Ověření velikosti výběru z dat sady
      description: Vrátí možnosti zobrazení a exportu podle definice obsahu sady pro výstupní formáty. Provede výpočet podle dimnezí, filtrů a nastavených rozbalení a deklaruje pro všechny formáty, které jsou k dispozici možnosti exportu. Pro interaktivní zobrazení deklaruje úrovně rozbalení dimenzí a hierarchie (drilldown) podle maximálního počtu. Pokud není předána definice výběru (prázné "body" v požadavku), vrací velikost kompletních dat sady dle výchozího výběru.
      operationId: postDatasetViewCheckResultSize
      parameters:
      - name: sadaKod
        in: path
        description: Kód datové sady
        required: true
        schema:
          type: string
      - name: Accept-Language
        in: header
        description: jazyk pro obsah odpovědi
        required: false
        schema:
          type: string
          default: cs
      - name: verzeSady
        in: query
        description: Verze datové sady
        required: false
        schema:
          type: string
      - name: casPlatnosti
        in: query
        description: Čas platnosti pro výběr hodnot vrácených sad podle času zveřejnění, výchozí je aktuální čas
        required: false
        schema:
          type: string
          format: date-time
      - name: idPripravenyImport
        in: query
        description: Identifikátor připraveného importu dat sady. Umožní číst připravená data (pouze pro vybrané role).
        required: false
        schema:
          type: integer
          format: int64
      - name: proUzivatele
        in: query
        description: Kód uživatele, pro kterého se výstup připravuje. Je povolené pouze pro roli asynchronních výstupů. Použije se pro určení rozsahu dat, které jsou ve výstupu.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObsahVyberu'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VelikostiVystupu'
    servers:
    - url: https://data.csu.gov.cz/api/dotaz/v1
      description: Generated server url
  /velikosti/sady/{sadaKod}:
    get:
      tags:
      - Velikosti
      summary: Ověření velikosti všech dat sady
      description: Vrátí možnosti zobrazení a exportu výchozího výběru celé sady podle definice obsahu sady pro výstupní formáty. Provede výpočet podle dimnezí, filtrů a nastavených rozbalení a deklaruje pro všechny formáty, které jsou k dispozici možnosti exportu.
      operationId: getDatasetCheckResultSize
      parameters:
      - name: sadaKod
        in: path
        description: Kód datové sady
        required: true
        schema:
          type: string
      - name: Accept-Language
        in: header
        description: jazyk pro obsah odpovědi
        required: false
        schema:
          type: string
          default: cs
      - name: verzeSady
        in: query
        description: Verze datové sady
        required: false
        schema:
          type: string
      - name: casPlatnosti
        in: query
        description: Čas platnosti pro výběr hodnot vrácených sad podle času zveřejnění, výchozí je aktuální čas
        required: false
        schema:
          type: string
          format: date-time
      - name: idPripravenyImport
        in: query
        description: Identifikátor připraveného importu dat sady. Umožní číst připravená data (pouze pro vybrané role).
        required: false
        schema:
          type: integer
          format: int64
      - name: proUzivatele
        in: query
        description: Kód uživatele, pro kterého se výstup připravuje. Je povolené pouze pro roli asynchronních výstupů. Použije se pro určení rozsahu dat, které jsou ve výstupu.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VelikostiVystupu'
    servers:
    - url: https://data.csu.gov.cz/api/dotaz/v1
      description: Generated server url
components:
  schemas:
    ObsahVyberu:
      type: object
      description: Nastavení vlastního výběru pro data
      properties:
        sloupce:
          type: array
          description: Seznam dimenzí ve sloupci
          items:
            $ref: '#/components/schemas/ObsahVyberuDimenze'
        radky:
          type: array
          description: Seznam dimenzí v řádku
          items:
            $ref: '#/components/schemas/ObsahVyberuDimenze'
        filtryTabulky:
          type: array
          description: Dimenze v záhlaví
          items:
            $ref: '#/components/schemas/ObsahVyberuDimenze'
        nepouziteDimenze:
          type: array
          description: Dimenze v záhlaví
          items:
            $ref: '#/components/schemas/ObsahVyberuDimenze'
        rozbaleni:
          type: array
          description: Rozbalené položky dimenzí, uvedené ve stromové struktuře v případě rozbalení vnořených položek
          items:
            $ref: '#/components/schemas/ObsahVyberuRozbalene'
        pridaneUkazatele:
          type: array
          description: 'Ukayatel jiné sady přidaný do výběru. Ukazatel musí mít dimenze kompatibilní s dimenzemi vlastní sady zařazenými do výběru. Nesmí mít další povinné typy dimenzí , které nejsou obsaženy ve vlastní sadě. '
          items:
            $ref: '#/components/schemas/ObsahVyberuPridanyUkazatel'
        casovaDimenze:
          $ref: '#/components/schemas/CasovaDimenze'
        nekonzistenceSady:
          $ref: '#/components/schemas/ObsahVyberuNekonzistenceSady'
    ObsahVyberuKonzistentniKombinace:
      type: object
      description: Varianta úpravy původní definice výběru, aby byla zajištěna konzistetní kombinace variant dimenzí v sadě
      properties:
        pridaneDimenze:
          type: array
          description: Výčet přidaných kódů dimenzí do výběru
          items:
            type: string
        odebraneDimenze:
          type: array
          description: Výčet odebraných kódů dimenzí do výběru
          items:
            type: string
    VelikostiVystupu_poctyZaznamu:
      type: object
      description: Údaje o maximálním počtu záznamů bez ohledu na formát a rozložení řádků a sloupců
      properties:
        zobrazene:
          type: integer
          format: int64
          description: Počty záznamů při stažení dat pro zobrazený výběr (s aplikací rozbalování dle aktuálního individuálního nastavení rozbalení položek dimenzí.
          minimum: 0
        rozbalene:
          type: integer
          format: int64
          description: Počty záznamů při aplikaci filtru v záhlaví, ale plném rozbalení dimenzí a rozbalení hierarchie do nastavené úrovně.
        bezFiltru:
          type: integer
          format: int64
          description: Plné rozbalení dimenzí a data za všechny filtry v záhlaví.
    ObsahVyberuFiltr:
      type: object
      description: 'Nastavení filtru na položky dimenze / výběr ukazatelů ve výběru z datové sady. Pro hiearchické číselníky je filtr uveden pro každou úroveň zvlášť. ~ v každé  úrovni položek varianty dimenze (včetně kořenové) se jako výchoz stav předpokládá, že jsou v úrovni vybrané VŠECHNY existující položky, pokud není uveden pozitivní ani negativní výčet (zobrazitPolozky / nezobrazitPolozky). ~ pro každou úroveň je uložen JEN JEDEN výčet položek - zobrazitPolozky nebo nezobrazitPolozky. Výčet může být při uložení optimalizován (uvede se výčet s nižším počtem položek). ~ v seznamu odlisnePodpolozky jsou bez ohledu na způsob pozitivního či negativního výčtu nastavení filtru indikovány takové zobrazené položky, kde se nastavení některých podpoložek liší. '
      properties:
        urovenHierarchieKod:
          type: string
          description: 'Informace o úrovni hierarchie položky s uvedeným identifikátorem (uvedeno u hiearchických dimenzí). '
        zobrazitPolozky:
          type: array
          description: Výčet identifikátorů položek dimenze. Není být současně uveden  filtr "nezobrazitPolozky".
          items:
            type: string
        nezobrazitPolozky:
          type: array
          description: Negativní výčet identifikátorů položek dimenze. Použije se jako alternativa k výčtu položek, pokud je zobrazena většina položek dimenze.
          items:
            type: string
        odlisnePodpolozky:
          type: array
          description: Seznam identifikátorů položek, jejichž některé podpoložky (v nižší úrovni hiearchického čísleníku) jsou nastaveny odlišně od nadřazené položky (některé podřazené položky nejsou zobrazovány). Informace je read-only a slouží pro indikaci při nastavování filtrů (nenahrazuje seznam zobrazených položek).
          items:
            type: string
    ObsahVyberuNekonzistenceSady:
      type: object
      description: Vrací se informace o modifikaci nastavení výběru po načtení z důvodu nekonzistence vůči aktuální modifikaci obsahu sady. Tento údaj se neukládá. Po novém uložení výběru obsahujícím dimenze aktuální sady se tyto údaje již nezobrazí, pokud je nově uložený výběr konzistentní s definicií sady.
      properties:
        sloupce:
          type: array
          description: Seznam diemenzí ve sloupci odebraných z uložené definice obsahu výběru z důvodu její neexistence v nové sadě.
          items:
            $ref: '#/components/schemas/ObsahVyberuDimenzeNekonzistence'
        radky:
          type: array
          description: Seznam diemenzí v řádku odebraných z uložené definice obsahu výběru z důvodu její neexistence v nové sadě.
          items:
            $ref: '#/components/schemas/ObsahVyberuDimenzeNekonzistence'
        filtryTabulky:
          type: array
          description: Seznam diemenzí ve filtru tabulky odebraných z uložené definice obsahu výběru z důvodu její neexistence v nové sadě.
          items:
            $ref: '#/components/schemas/ObsahVyberuDimenzeNekonzistence'
        povoleneKombinaceDimenzi:
          type: array
          description: V případě, že sada má definovány povolené kombinace  variant dimenzí a původní definice obsahu výběru požadavek nesplňuje, obsahuje toto pole návrhy na úpravu výběru v souladu s nastavením sady. První návrh je aplikován v úpravě výběru změnou dimenzí (PRIDANA_POVOLENA_KOMBINACE, ZRUSENA_NEPOVOLENA_KOMBINACE)
          items:
            $ref: '#/components/schemas/ObsahVyberuKonzistentniKombinace'
    VelikostiVystupu:
      type: object
      description: 'Informace o velikosti požadovaného výstupu v různých formátech.  Vypočte se tímto algoritmem: a) Sloupce a řádky bez filtru tabulky jako násobek počtu prvků požadovaných dimenzí. U řádků se navíc vynásobí počtem prvků dimenzí ve filtru tabulky b) Sloupce a řádky jako násobek počtu prvků požadovaných dimenzí a úrovní dimenzí se zahrnutím filtrů tabulky v obsahVyberu. Filtry tabulky nijak nemění výsledek. c) rozbaleniDimenzi - provede se zvlášť pro sloupce a řádky   - Pokud je v obsahu výběru definováno rozbalení hierarchie - uvedou se rozbalené prvky až do definované úrovně se zohledněním filtrů   - Pokud je v obsahu výběru navíc definováno i individuální rozbalení, ignorují pravidla pro rozbalování a definice rozbalení hierarchie.   - Pokud není na aktuální úrovni definováno rozbalení hierarchie ani individuální rozbalení, postupně se přidávají do rozbalení další celé úrovně hierarchie, dokud se nenaplní limit FLEXMONSTER_API pro řádek/sloupec. Při překročení se se rozbalení pro celou úroveň neprovede. Přednost na úrovni s hierarchií má "rozbalitPolozkyHierarchie" před "rozbalitPolozky"'
      properties:
        limity:
          type: array
          items:
            $ref: '#/components/schemas/VelikostiVystupuLimityInner'
        velikosti:
          $ref: '#/components/schemas/VelikostiVystupu_velikosti'
        poctyZaznamu:
          $ref: '#/components/schemas/VelikostiVystupu_poctyZaznamu'
    ObsahVyberuDimenzeNekonzistence:
      type: object
      description: Popis nekonzistence dimenze v definici sady
      properties:
        kodDimenze:
          type: string
          description: kód dimenze v rámci definice datové sady, nebo kód "IndicatorType" pro zobrazení ukazatelů.
        nekonzistence:
          type: array
          description: 'Výpis typů nekonzistencí v dimenzi použité v výběru. Zrušené dimenze jsou z výběru odebrány. Pokud byla nastavena úroveň rozbalení pro neexistující úroveň dimenze, je toto nastavení zrušeno. Pokud byly použity položky pro filtraci (negativní a pozitivní) jsou tyto filtry zrušeny: ZRUSENA  .. V sadě se dimenze nenachází (např. byla ze sady zrušena) ZRUSENA_DUPLICITNI .. Dimenze stejneho typu nebo tatáž se vyskytuje duplicitně vícekrát ve výběru (ve stejné skupině či různých skupinách). CHYBI_UROVEN_DIMENZE  .. Nastavená úroveň dimenze už neexistuje, dimenze ve výběru zůstává, ale úroveň je nastavena na výchozí CHYBI_POLOZKY_FILTRU .. Některé položky filtru dimenze/ukzatele už v dimenzi/sadě neexistují PRIDANA_VARIANTA .. Původní nastavená varianta dimenze už v sadě neexistuje, msto toho byla automaticky přidána varianta PRIDANA_POVINNY_TYP .. Typ dimenze je povinný, ale nebyla k němu ve výběru žádná varianta dimenze. Byla vybrána první výchozí PRIDANA_POVOLENA_KOMBINACE, ZRUSENA_NEPOVOLENA_KOMBINACE .. Sada umožňuje zobrazit jen některé kombinace dimenzí. Dimenze byla přidána ve výchozí povolené kombinaci PRIDANA_KOMPLET ..  Dimenze byla přidána jako výchozí daného typu pro účely výběru kompletní sady (volitelný parametr) '
          items:
            type: string
            enum:
            - ZRUSENA
            - ZRUSENA_DUPLICITNI
            - CHYBI_UROVEN_DIMENZE
            - CHYBI_POLOZKY_FILTRU
            - PRIDANA_VARIANTA
            - PRIDANA_POVINNY_TYP
            - PRIDANA_POVOLENA_KOMBINACE
            - ZRUSENA_NEPOVOLENA_KOMBINACE
            - ZRUSEN_NEPLATNY_FILTR
            - PRIDANA_KOMPLET
            - NAHRAZENA_VARIANTOU
        zrusenePolozkyFiltru:
          type: array
          description: Kód položek dimenze, které byly vybrány pro zobrazení. Pro typ "CHYBI_POLOZKY_FILTRU"
          items:
            type: string
      required:
      - kodDimenze
    ObsahVyberuPridanyUkazatel:
      type: object
      description: 'Ukazatel jiné sady přidaný do výběru. Ukazatel musí mít dimenze kompatibilní s dimenzemi vlastní sady zařazenými do výběru. Nesmí mít další povinné typy dimenzí , které nejsou obsaženy ve vlastní sadě. '
      properties:
        sadaKod:
          type: string
        sadaVerze:
          type: string
        ukazatelKod:
          type: string
    CasovaDimenze:
      type: object
      description: Způsob chování časové dimenze
      properties:
        typAktualizacePolozek:
          type: string
          description: Způsob výběru aktuálních položek
          enum:
          - MANUALNE
          - POSLEDNICH_N
          - PRIDAT_NOVE
          example: POSLEDNICH_N
        pocet:
          type: integer
          format: int32
          description: Počet posledních položek nejnižší definované úrovně hierarchie časové dimenze (REF_CAS). Uvádí se jen pro variantu POSLEDNICH_N
        casAktualizace:
          type: string
          format: date-time
          description: Čas aktualizace filtrů výběru. Reálný rozsah hodnot v sadě odpovídá tomuto času. Je vyplněno při načtení výběru, pokud je k dispozici obsah sady.
        urovenPridanychPolozek:
          type: string
          description: Úroveň hiearchie pro přidávané položky
    ObsahVyberuRozbalene:
      type: object
      description: 'Rekurzivní struktura pro rozbalení hierarchie a dimenzí. Musí odpovídat definici hierarchie dimenzí, řádků a sloupců, jinak se rozbalení položky v dané úrovni neaplikuje. '
      properties:
        dim:
          type: string
          description: Kód dimenze rozbalené položky. Pro první úroveň musí jít o první dimenzi v řádku nebo sloupci atd.
        uroven:
          type: string
          description: Kód úrovně dimenze - uvedeno jen u hierarchických
        kod:
          type: string
          description: Kód rozbalené položky
        typ:
          type: string
          description: 'Typ rozbalení: EXP - rozbalení další dimeneze (expand) DRILL - rozbalení další urovně (drilldown) '
          enum:
          - EXP
          - DRILL
        vnorene:
          type: array
          description: Rozbalení vnořených položek. Je vyplněno pouze, pokud je rozbalena další úroveň.
          items:
            $ref: '#/components/schemas/ObsahVyberuRozbalene'
      required:
      - dim
      - kod
      - typ
    VelikostiVystupu_velikosti:
      type: object
      description: Vypočtené velikosti výsledku
      properties:
        sloupce:
          type: integer
          format: int64
          description: Počet sloupců k zobrazení s aplikací filtru
        radky:
          type: integer
          format: int64
          description: Počet řádků k zobrazení s aplikací filtru
        sloupceBezFiltru:
          type: integer
          format: int64
          description: Počet sloupců bez aplikace filtru tabulky záhlaví.
        radkyBezFiltru:
          type: integer
          format: int64
          description: Počet řádků bez aplikace filtrů záhlaví tabulky. Je rozšířeno o všechny dimenze ve filtru tabulky (přidáno do počtu řádků). Pokud má výstup více stránek, zahrnuje počet řádky za všechny listy dohromady.
        listyBezFiltru:
          type: integer
          format: int64
          description: Počet listů bez aplikace filtrů záhlaví tabulky. Je rozšířeno o všechny dimenze ve filtru záhlaví taulky v případě, že výstup je nastaven pro stažení po listech (funkční pro XLSX, HTML).
        rozbaleneSloupce:
          type: integer
          format: int64
          description: Počet rozbalených sloupců včetně hierarchie (jen pokud je aplikovatelné)
        rozbaleneRadky:
          type: integer
          format: int64
          description: Počet rozbalených řádků včetně hierarchie (jen pokud je aplikovatelné)
    VelikostiVystupuLimityInner:
      type: object
      properties:
        format:
          type: string
          enum:
          - XLSX
          - CSV
          - JSON_STAT
          - HTML
          - SNIPPET
          - DIVTABLE
        vyberCely:
          type: string
          description: Možnosti stažení dat pro celý výběr (bez filtrů záhlaví tabulky). Pro rozbalení hiearchií se aplikuje úroveň nastavená ve výběru (drill-down). Dimenze se zobrazují všechny (expand). Na FLEXMONSTER_API se neaplikuje.
          enum:
          - PRIMY_VYSTUP
          - ODLOZENY_VYSTUP
          - NELZE
          example: ODLOZENY_VYSTUP
        vyberFiltry:
          type: string
          description: Možnosti stažení dat pro výběr (s aplikací nastavených filtrů záhlaví tabulky).  Pro rozbalení hiearchií se aplikuje úroveň nastavená ve výběru (drill-down). Dimenze se zobrazují všechny (expand). Na FLEXMONSTER_API se neaplikuje.
          enum:
          - PRIMY_VYSTUP
          - ODLOZENY_VYSTUP
          - NELZE
        vyberZobrazene:
          type: string
          description: Možnosti stažení dat pro zobrazený výběr (s aplikací rozbalování dle aktuálního individuálního nastavení rozbalení položek). Pro FLEXMONSTER_API nelze  provést odložený výstup. Varianta ROZBALENI_OMEZENO je deprecated.
          enum:
          - PRIMY_VYSTUP
          - ODLOZENY_VYSTUP
          - ROZBALENI_OMEZENO
          - NELZE
        rozbaleniDimenzi:
          type: array
          deprecated: true
          description: Výchozí finální rozbalení (expand + drilldown) pro obsah výběru dle nastavených pravidel pro případ, kdy  je možné pro daný formát provést "vyberZobrazene" v režimu PRIMY_VYSTUP
          items:
            $ref: '#/components/schemas/ObsahVyberuRozbalene'
    ObsahVyberuDimenze:
      type: object
      properties:
        kodDimenze:
          type: string
          description: kód dimenze v rámci definice datové sady, nebo kód "#UKAZATEL" pro zobrazení ukazatelů.
        razeni:
          type: string
          description: řazení dimenze v sestavě
          enum:
          - kod
          - nazev
          - kodSestupne
          - nazevSestupne
          - vychozi
          - vychoziSestupne
        popis:
          type: string
          description: Zobrazený typ popisu položky
          enum:
          - nazev
          - kod
          - kodNazev
          - nazevKod
        zdrojPopisu:
          type: string
          description: Typ zdrojového textu názvu v popisu položky.
          enum:
          - NAZEV
          - ZKRACENY_NAZEV
          - ALTERNATIVNI_NAZEV
          - ROZSIRENY_NAZEV
        rozbalitUroven:
          type: string
          description: úroveň rozbalení hierarchie (kód úrovně hierarchie do které je rozbaleno výchozí zobrazení)
        filtr:
          type: array
          items:
            $ref: '#/components/schemas/ObsahVyberuFiltr'
        filtrTabulkyKod:
          type: string
          description: Kód položky dimenze, na níž je výběr nafiltrován. Použije se pouze pro filtr tabulky (ne pro řádku a sloupec)
        casovaDimenze:
          $ref: '#/components/schemas/CasovaDimenze'
      required:
      - kodDimenze
x-refined-from:
- csu-gov-cz-dotaz-api-docs.json
- csu-gov-cz-datastat-query-openapi.yml