VelikostiVystupu

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/csu-gov-cz/json-schema/csu-gov-cz-velikosti-vystupu-schema.json",
  "title": "VelikostiVystupu",
  "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\"",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/csu-gov-cz-datastat-query-openapi.yml#/components/schemas/VelikostiVystupu",
  "type": "object",
  "properties": {
    "limity": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/VelikostiVystupuLimityInner"
      }
    },
    "velikosti": {
      "$ref": "#/$defs/VelikostiVystupu_velikosti"
    },
    "poctyZaznamu": {
      "$ref": "#/$defs/VelikostiVystupu_poctyZaznamu"
    }
  },
  "$defs": {
    "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": "#/$defs/ObsahVyberuRozbalene"
          }
        }
      },
      "required": [
        "dim",
        "kod",
        "typ"
      ]
    },
    "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"
          ]
        },
        "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": "#/$defs/ObsahVyberuRozbalene"
          }
        }
      }
    },
    "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í."
        }
      }
    },
    "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é)"
        }
      }
    }
  }
}