{"openapi":"3.1.0","info":{"title":"server","description":"","contact":{"name":"AG umwelt.info","email":"umwelt.info@uba.de"},"license":{"name":"AGPL-3.0-or-later","identifier":"AGPL-3.0-or-later"},"version":"0.1.0"},"paths":{"/ckan/api/3/action/help_show":{"get":{"tags":["ckan"],"operationId":"help_show","parameters":[{"name":"name","in":"query","required":false,"schema":{"type":["string","null"],"default":"package_search"}}],"responses":{"200":{"description":"CKAN help","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HelpShowPage"}}}}}}},"/ckan/api/3/action/package_search":{"get":{"tags":["ckan"],"summary":"Search datasets in CKAN format","operationId":"package_search","parameters":[{"name":"q","in":"query","description":"Query following the syntax described in ","required":false,"schema":{"type":"string"}},{"name":"rows","in":"query","description":"Number of rows to be returned","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1}},{"name":"start","in":"query","description":"Zero-based offset from where rows should be returned.","required":false,"schema":{"type":"integer","minimum":0}}],"responses":{"200":{"description":"Result of the given query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageSearchPage"}}}}}}},"/ckan/api/3/action/package_show":{"get":{"tags":["ckan"],"summary":"Request single datasets in CKAN format","operationId":"package_show","parameters":[{"name":"id","in":"query","description":"Unique identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested dataset","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageShowPage"}}}}}}},"/classify_relevance":{"get":{"tags":["classification"],"operationId":"classify_relevance","parameters":[{"name":"text","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Probability that given the text describes environmental or nature conservation information","content":{"application/json":{"schema":{"type":"array","items":{"type":"number","format":"float"}}}}}}}},"/complete":{"get":{"tags":["search"],"summary":"Autocompletions for a given query","description":"This will yield completions for last term in the given query,\nbut only if has at least three characters.","operationId":"text_complete","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Language used to interpret query in","required":false,"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/SearchLanguage"}]}}],"responses":{"200":{"description":"Available completions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompletePage"}}}}}},"post":{"tags":["search"],"summary":"Autocompletions for a given query","description":"This will yield completions for last term in the given query,\nbut only if has at least three characters.","operationId":"struct_complete","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteParams_StructQuery"}}},"required":true},"responses":{"200":{"description":"Available completions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompletePage"}}}}}}},"/counts/all":{"get":{"tags":["counts"],"operationId":"counts_all","responses":{"200":{"description":"Counts aggregated over the whole index, past values","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimestampedCounts"}}}}}}}},"/counts/now":{"get":{"tags":["counts"],"operationId":"now","responses":{"200":{"description":"Counts aggregated over the whole index, current values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Counts"}}}}}}},"/dataset/all":{"get":{"tags":["dataset"],"summary":"Efficiently stream all datasets in a single request","operationId":"dataset_all","parameters":[{"name":"sampling_fraction","in":"query","description":"If set, randomly yields only the given fraction of results.","required":false,"schema":{"type":["number","null"],"format":"float"}},{"name":"language","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SearchLanguage"}}],"responses":{"200":{"description":"Stream of all datasets","content":{"application/x-ndjson":{"schema":{"$ref":"#/components/schemas/UniquelyIdentifiedDataset"}}}}}}},"/dataset/random":{"get":{"tags":["dataset"],"summary":"Access a randomly chosen data set","operationId":"random","responses":{"200":{"description":"Random dataset","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UniquelyIdentifiedDataset"}}}}}}},"/dataset/{source}/{id}":{"get":{"tags":["dataset"],"summary":"Access a single dataset","operationId":"single","parameters":[{"name":"source","in":"path","description":"Name of the source","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Identifier of the dataset within the source","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Content of queried data set","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetPage"}},"text/html":{"schema":{"$ref":"#/components/schemas/DatasetPage"}}}}}}},"/dataset/{source}/{id}/redirect":{"get":{"tags":["dataset"],"summary":"Redirect to the source URL of a dataset","operationId":"redirect","parameters":[{"name":"source","in":"path","description":"Name of the source","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Identifier of the dataset within the source","required":true,"schema":{"type":"string"}}],"responses":{"303":{"description":"Redirect to the source URL of queried data set"}}}},"/origin/{id}":{"get":{"tags":["origin"],"summary":"Retrieve backgound information on data providers","operationId":"origin","parameters":[{"name":"id","in":"path","description":"Path to requested origin","required":true,"schema":{"type":"string"},"example":"Bund/UBA"}],"responses":{"200":{"description":"Metadata of best-matching origin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OriginPage"}},"text/html":{"schema":{"$ref":"#/components/schemas/OriginPage"}}}}}}},"/search":{"get":{"tags":["search"],"summary":"Search for multiple datasets","operationId":"text_search","parameters":[{"name":"query","in":"query","description":"Query following the syntax described in \n\nThe following fields are available to queries:\n
\n
title
titles both in German and English (example query: title:\"Pflanzenschutz im Garten\")
\n
description
descriptions both in German and English (example query: description:Waldumbau)
\n\n
measurement
details on measurements such as measurend variables or method applied (example query: measurements:PM10)
\n
taxon
details such as taxonomic or conservation status (example query: taxon:gefährdet)
\n
names
proper names like scientific and common species names (example query: names:\"Großblättriger Milchlattich\")
\n\n
organisation
organisation names both in German and English (example query: organisation:Umweltbundesamt)
\n
person
person name
\n\n
tags
tag labels both in German and English (example query: tags:Wasserrahmenrichtlinie)
\n
region
region names (example query: region:Niedersachsen)
\n\n
machine_readable_data
retrieve only datasets flagged as machine readable data (example query: machine_readable_data:true)
\n
mandatory_registration
filter out datasets requiring a registration to access them (example query: mandatory_registration:false)
\n\n
umthes_id
tag ID from the Umwelthesaurus (example query for Wasserstand: umthes_id:160581)
\n
wikidata_id
organisation ID from Wikidata (example query for Umweltbundesamt: wikidata_id:2491722)
\n
geonames_id
region ID from GeoNames (example query for Nordrhein-Westfalen: geonames_id:2861876)
\n
regional_key
region ID according to Amtliche Gemeindeschlüssel (AGS) and Amtlicher Regionalschlüssel (ARS) (example query for Flensburg: regional_key:010010000000)
\n
atkis_key
region ID according to Amtliche Topographisch-Kartographische Informationssystem (ATKIS) (example query for the town of Kremmen: atkis_key:3244)
\n
watershed_id
region ID of watersheds according to the Water Information System Europe (example query for the river Main: watershed_id:DE2400)
\n
surface_water_id
region ID of surface waters according to the Water Information System Europe
\n
wksb_id
region ID of water bodies according to Wasserkörpersteckbriefe (example query for Kanäle südlich der Spree: wksb_id:DERW_DEBE_58296
\n
cas_rn
chemical compound according to the Chemical Abstracts Service Registry Number (example query for phosphate: cas_rn:cas_rn:CAS_7723-14-0)
\n
orcid
ORCID according to ORCID (example query for a PID: orcid:orcid:0000-0003-1985-6426)
\n\n
source
technical ID of a source (example query: source:metadaten-uba
\n
id
technical ID of a dataset within a source (example query: source:metadaten-uba AND id:5008327d-c127-4a81-bbf2-8c8dd6d438b8)
\n
","required":false,"schema":{"type":"string"}},{"name":"types_root","in":"query","description":"Entry point for faceted search of types (example query \"/Taxon\", which gives all entries related to the type Taxon)","required":false,"schema":{"type":"string"},"example":"/Taxon"},{"name":"topics_root","in":"query","description":"Entry point for faceted search of tags","required":false,"schema":{"type":"string"},"example":"/Boden"},{"name":"origins_root","in":"query","description":"Entry point for faceted search of origins","required":false,"schema":{"type":"string"},"example":"/Land"},{"name":"licenses_root","in":"query","description":"Entry point for faceted search of licenses","required":false,"schema":{"type":"string"},"example":"/offen"},{"name":"languages_root","in":"query","description":"Entry point for faceted search of languages","required":false,"schema":{"type":"string"},"example":"/Deutsch"},{"name":"resource_types_root","in":"query","description":"Entry point for faceted search of resources types","required":false,"schema":{"type":"string"},"example":"/Datei"},{"name":"page","in":"query","description":"Return results from the given page","required":false,"schema":{"type":"integer","minimum":0},"example":3},{"name":"results_per_page","in":"query","description":"Number of results per page","required":false,"schema":{"type":"integer","maximum":100,"minimum":1},"example":7},{"name":"language","in":"query","description":"Language used to interpret query in (available are \"de\" for German and \"en\" for English)","required":false,"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/SearchLanguage"}]},"example":"de"},{"name":"bounding_box_west","in":"query","description":"Minimum longitude of results using WGS84","required":false,"schema":{"type":["number","null"],"format":"double","maximum":180,"minimum":-180},"example":5.99},{"name":"bounding_box_south","in":"query","description":"Minimum latitude of results using WGS84","required":false,"schema":{"type":["number","null"],"format":"double","maximum":90,"minimum":-90},"example":47.3},{"name":"bounding_box_east","in":"query","description":"Maximum longitude of results using WGS84","required":false,"schema":{"type":["number","null"],"format":"double","maximum":180,"minimum":-180},"example":15.02},{"name":"bounding_box_north","in":"query","description":"Maximum latitude of results using WGS84","required":false,"schema":{"type":["number","null"],"format":"double","maximum":90,"minimum":-90},"example":54.98},{"name":"bounding_box_contains","in":"query","description":"Whether the bounding box must fully contain instead of just intersect the bounding box of the dataset","required":false,"schema":{"type":"boolean"}},{"name":"bounding_box_spatial_clusters","in":"query","description":"Whether to aggregate the results within the given bounding box into spatial clusters","required":false,"schema":{"type":"boolean"}},{"name":"time_range_from","in":"query","description":"Lower bound of time range (format: YYYY-MM-DD)","required":false,"schema":{"type":["string","null"],"format":"date"},"example":"2005-05-15"},{"name":"time_range_until","in":"query","description":"Upper bound of time range (format: YYYY-MM-DD)","required":false,"schema":{"type":["string","null"],"format":"date"},"example":"2024-10-20"},{"name":"time_range_contains","in":"query","description":"Whether the time range must fully contain instead of just intersect the time range associated with the dataset","required":false,"schema":{"type":"boolean"}},{"name":"origin_weights","in":"query","description":"Enables selectively weighing the given origins\n\nThis can be given multiple times and takes the form `^`\nwhere `` can be a prefix, so for example\n\n```text\n&origin_weights=/Bund^0.5&origin_weights=/Land^2.0\n```\n\nwill half the score of all results with origins starting with `/Bund`\nand double the score of all results with origins starting with `/Land`.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Matching datasets and facets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPage_TextQuery"}},"text/html":{"schema":{"$ref":"#/components/schemas/SearchPage_TextQuery"}}}}}},"post":{"tags":["search"],"summary":"Search for multiple datasets","operationId":"struct_search","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchParams_StructQuery"}}},"required":true},"responses":{"200":{"description":"Matching datasets and facets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPage_StructQuery"}},"text/html":{"schema":{"$ref":"#/components/schemas/SearchPage_StructQuery"}}}}}}},"/search/all":{"get":{"tags":["search"],"summary":"Efficiently stream all datasets matching a given query in a single request","operationId":"text_search_all","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Language used to interpret query in","required":false,"schema":{"$ref":"#/components/schemas/SearchLanguage"}},{"name":"bounding_box_west","in":"query","description":"Minimum longitude of results using WGS84","required":false,"schema":{"type":["number","null"],"format":"double","maximum":180,"minimum":-180}},{"name":"bounding_box_south","in":"query","description":"Minimum latitude of results using WGS84","required":false,"schema":{"type":["number","null"],"format":"double","maximum":90,"minimum":-90}},{"name":"bounding_box_east","in":"query","description":"Maximum longitude of results using WGS84","required":false,"schema":{"type":["number","null"],"format":"double","maximum":180,"minimum":-180}},{"name":"bounding_box_north","in":"query","description":"Maximum latitude of results using WGS84","required":false,"schema":{"type":["number","null"],"format":"double","maximum":90,"minimum":-90}},{"name":"bounding_box_contains","in":"query","description":"Whether the bounding box must fully contain instead of just intersect the bounding box of the dataset","required":false,"schema":{"type":"boolean"}},{"name":"time_range_from","in":"query","description":"Lower bound of time range","required":false,"schema":{"type":["string","null"],"format":"date"}},{"name":"time_range_until","in":"query","description":"Upper bound of time range","required":false,"schema":{"type":["string","null"],"format":"date"}},{"name":"time_range_contains","in":"query","description":"Whether the time range must fully contain instead of just intersect the time range associated with the dataset","required":false,"schema":{"type":"boolean"}},{"name":"sampling_fraction","in":"query","description":"If set, randomly yields only the given fraction of results.","required":false,"schema":{"type":["number","null"],"format":"float"}}],"responses":{"200":{"description":"Stream of matching datasets","content":{"application/x-ndjson":{"schema":{"$ref":"#/components/schemas/UniquelyIdentifiedDataset"}}}}}},"post":{"tags":["search"],"summary":"Efficiently stream all datasets matching a given query in a single request","operationId":"struct_search_all","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchAllParams_StructQuery"}}},"required":true},"responses":{"200":{"description":"Stream of matching datasets","content":{"application/x-ndjson":{"schema":{"$ref":"#/components/schemas/UniquelyIdentifiedDataset"}}}}}}},"/top-n/datasets":{"get":{"tags":["top_n"],"operationId":"datasets","parameters":[{"name":"n","in":"query","required":false,"schema":{"type":"integer","minimum":0}},{"name":"language","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SearchLanguage"}}],"responses":{"200":{"description":"The top n datasets by accesses","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TopNDataset"}}}}}}}},"/top-n/tags":{"get":{"tags":["top_n"],"operationId":"tags","parameters":[{"name":"n","in":"query","required":false,"schema":{"type":"integer","minimum":0}},{"name":"language","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SearchLanguage"}}],"responses":{"200":{"description":"The top n tags by queries","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopNTag"}}}}}}}},"components":{"schemas":{"Accessibility":{"type":"object","description":"This quality dimension indicates how well this dataset can be accessed.","required":["landing_page","landing_page_score","direct_access","publicly_accessible","score"],"properties":{"direct_access":{"type":"boolean","description":"This score indicates if a direct link to the primary content exists.\n\nThe following two criteria must be met:\n - Direct links must be machine-navigable, i.e. without any impediments like accepting cookies / terms of use or requiring logins / sessions.\n - They must link the primary content referenced in the dataset description (e.g. press releases, data tables), i.e. no user manuals, background information or similar."},"landing_page":{"$ref":"#/components/schemas/QualityLandingPage"},"landing_page_score":{"type":"number","format":"float","description":"Numeric represenation of `landing_page` field."},"publicly_accessible":{"type":"boolean","description":"Indicates that no additional barriers like fees or registrations are required to access the data."},"score":{"type":"number","format":"float","description":"overall score of this quality dimension"}}},"BoundingBox":{"type":"object","description":"An axis-aligned bounding box defined by its two corners","required":["min","max"],"properties":{"max":{"$ref":"#/components/schemas/Corner","description":"North-east corner of the bounding box"},"min":{"$ref":"#/components/schemas/Corner","description":"South-west corner of the bounding box"}}},"ChemicalCompound":{"type":"object","required":["name","synonyms"],"properties":{"cas_registry_number":{"type":["string","null"]},"name":{"type":"string"},"synonyms":{"type":"array","items":{"type":"string"}}}},"CkanDataset":{"type":"object","description":"Representation of a dataset in CKAN compatible format.\n\nThe main model is taken from ,\nand the usage of keys in the 'extras' field follows as much as possible their usage by the GovData CKAN API.\n\nThe following optional parameters are not implemented as they have no reprensentation in the dataset schema:\n\n- metadata_created,\n- metadata_modified,\n- geographical_coverage,\n- version,\n- state\n- type\n- vocabularies,\n- organization (GovData uses a field \"organization\" that describes one organization responsible for the dataset. It provides informational context to \"owner_org\" field),\n- plugin_data,\n- relationships_as_object,\n- relationships_as_subject,\n- groups,\n- owner_org,","required":["id","name","title","private","url","resources","tags","extras"],"properties":{"author":{"type":["string","null"],"description":"Name of the dataset’s author (optional)"},"author_email":{"type":["string","null"],"description":"Email address of the dataset’s author (optional)"},"extras":{"type":"array","items":{"$ref":"#/components/schemas/CkanExtra"},"description":"(list of dataset extra dictionaries) – extra information on the dataset (optional), extras are arbitrary (key: value) metadata items that can be added to datasets, each extra dictionary should have keys 'key' (a string), 'value' (a string)"},"id":{"type":"string","description":"Unique identifier"},"license_title":{"type":["string","null"],"description":"Name of the dataset's license"},"license_url":{"type":["string","null"],"description":"URL of the dataset’s license"},"maintainer":{"type":["string","null"],"description":"Name of the dataset’s maintainer (optional)"},"maintainer_email":{"type":["string","null"],"description":"Email address of the dataset’s maintainer (optional)"},"name":{"type":"string","description":"Name of the dataset in the form {source_id}/{dataset_id}"},"notes":{"type":["string","null"],"description":"Description of the dataset (optional)"},"private":{"type":"boolean","description":"If True, marks a private dataset. There are no private datasets in here, so it is always false."},"resources":{"type":"array","items":{"$ref":"#/components/schemas/CkanResource"},"description":"the resources attached to the dataset, see for the format of resource dictionaries (optional)"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/CkanTag"},"description":"the tags associated with the dataset, see for the format of tag dictionaries (optional)"},"title":{"type":"string","description":"Title of the dataset"},"url":{"type":"string","description":"URL for the dataset’s source (optional)"}}},"CkanExtra":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string"},"value":{"type":"string"}}},"CkanResource":{"type":"object","description":"Representation of a resource in CKAN compatible format.\n\nModelled after \n\nThe folowing additional fields are included to following GovData:\n\n- download_url\n\nThe following optional fields are ommitted as they have no representation in our Resource:\n\n- license,\n- mimetype_inner","required":["url","package_id"],"properties":{"description":{"type":["string","null"],"description":"Description of the resource content"},"download_url":{"type":["string","null"],"description":"If the URL allows a direct download of the resource, this field is filled."},"format":{"type":["string","null"],"description":"Long name of format"},"mimetype":{"type":["string","null"],"description":"mimetype if the format has a direct equivalent"},"package_id":{"type":"string","description":"ID of package that the resource should be added to."},"url":{"type":"string","description":"URL of resource"}}},"CkanSearchResults":{"type":"object","required":["count","facets","search_facets","sort","results"],"properties":{"count":{"type":"integer","minimum":0},"facets":{"type":"array","items":{"type":"string"}},"results":{"type":"array","items":{"$ref":"#/components/schemas/CkanDataset"}},"search_facets":{"type":"array","items":{"type":"string"}},"sort":{"type":"string"}}},"CkanTag":{"type":"object","required":["name"],"properties":{"id":{"type":["string","null"]},"name":{"type":"string"}}},"Clause":{"oneOf":[{"type":"object","required":["phrase"],"properties":{"field_name":{"type":["string","null"]},"occur":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Occur"}]},"phrase":{"type":"string"}}},{"type":"object"}]},"CompletePage":{"type":"object","required":["completions","similar_terms","matching_fields","types","topics","origins","licenses","languages","resource_types"],"properties":{"completions":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","minimum":0}]},"description":"Suffixes which complete to matching terms, for the given or default fields\n\nAttached to each term is the number of matching datasets."},"languages":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","minimum":0}]},"description":"Languages which contain the given term\n\nAttached to each value is the number of matching datasets."},"licenses":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","minimum":0}]},"description":"Licenses which contain the given term\n\nAttached to each value is the number of matching datasets."},"matching_fields":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","minimum":0}]},"description":"Field names with exact matches for the given term\n\nAttached to each term is the number of matching datasets."},"origins":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","minimum":0}]},"description":"Origins which contain the given term\n\nAttached to each value is the number of matching datasets."},"resource_types":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","minimum":0}]},"description":"Resource types which contain the given term\n\nAttached to each value is the number of matching datasets."},"similar_terms":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","minimum":0}]},"description":"Terms similar to the given terms, even if they are not suffixes\n\nAttached to each term is the number of matching datasets."},"topics":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","minimum":0}]},"description":"Topics which contain the given term\n\nAttached to each value is the number of matching datasets."},"types":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","minimum":0}]},"description":"Types which contain the given term\n\nAttached to each value is the number of matching datasets."}}},"CompleteParams_StructQuery":{"type":"object","required":["query"],"properties":{"language":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/SearchLanguage","description":"Language used to interpret query in"}]},"query":{"type":"array","items":{"$ref":"#/components/schemas/Clause"},"description":"Structured representation of a query as a list of clauses\n\nAn empty list or a single empty clause will be interpreted as the all query."}}},"Corner":{"type":"object","required":["x","y"],"properties":{"x":{"type":"number","format":"double","description":"Longitude using WGS84"},"y":{"type":"number","format":"double","description":"Latitude using WGS84"}}},"Counts":{"type":"object","required":["datasets","sources","providers","failed_harvests","errors"],"properties":{"datasets":{"type":"integer","description":"Number of distinct datasets","minimum":0},"errors":{"type":"integer","description":"Sum of errors encountered by all harvesters","minimum":0},"failed_harvests":{"type":"integer","description":"Number of data sources which we failed to harvest","minimum":0},"providers":{"type":"integer","description":"Number of distinct providers, i.e. institutions operating one or more data sources","minimum":0},"sources":{"type":"integer","description":"Number of distinct data sources, i.e. technical interfaces yielding one or more datasets","minimum":0}}},"Dataset":{"type":"object","required":["title","source_url"],"properties":{"alternatives":{"type":"array","items":{"$ref":"#/components/schemas/LabelledAlternative"},"description":"URL to alternative versions of this dataset, e.g. other sources or languages"},"bounding_boxes":{"type":"array","items":{"$ref":"#/components/schemas/BoundingBox"},"description":"The extents of the dataset in the geographic space, given as as axis-aligned bounding boxes based on WGS84"},"comment":{"type":["string","null"],"description":"An optional comment adding auxiliary information on the dataset"},"description":{"type":["string","null"],"description":"The optional description of the dataset"},"global_identifier":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/GlobalIdentifier"}]},"issued":{"type":["string","null"],"format":"date","description":"The date at which the dataset was originally issued"},"language":{"$ref":"#/components/schemas/LabelledLanguage"},"license":{"$ref":"#/components/schemas/LinkedLicense"},"machine_readable_source":{"type":"boolean","description":"Indicates whether the source provided machine-readable metadata\n\nIf not set, the dataset had to be scraped or otherwise inferred from unstructured data."},"mandatory_registration":{"type":"boolean"},"modified":{"type":["string","null"],"format":"date","description":"The date at which the dataset was last modified"},"organisations":{"type":"array","items":{"$ref":"#/components/schemas/LabelledOrganisation"}},"origins":{"type":"array","items":{"type":"string"},"description":"Hierachical short-hand of origin, e.g. the instition from which the dataset was harvested.\n\nHere, we describe what pattern we use to define the origin(s) of different data sources.\n\n## Decisions\n- In general, we are guided by [DCAT-AP.de](https://www.dcat-ap.de/def/dcatde/2.0/spec/).\n- We aim to structure the hierachry as follows: `//`.\n- If multiple organisations are involved, we do attach multiple origins to single datasets to improve their findability.\n- We call this structure **origin**, a word currently not used in DCAT-AP.de to avoid confusion.\n\n## Definitions\n### dct:type\n> The nature or genre of the resource.\n\nWe broadly catagorise the publisher type, like an NGO being part of society (_Zivilgesellschaft_), Regional Authorities are usually embedded into federal states (_Land_), etc.\n\n### dct:publisher\n> The entity responsible for making the item available.\n\nWe use **organisations** who own the data/information, either by creating and owning the propierties themselves, or through contracts awarded to other organisations (_Im Auftrag von_). Examples are government departments, like Bundesministerium für Strahlenschutz (BfS), or state agencies, like Umweltbundesamt (UBA).\n\n### dcat:catalog\n> Represents a catalog, which is a dataset in which each individual item is a metadata record describing some resource; the scope of dcat:Catalog is collections of metadata about datasets or data services.\n\nTo simplify our structure, this catalog can be a website, web application, or any other openly accessible data/information offer."},"persons":{"type":"array","items":{"$ref":"#/components/schemas/Person"}},"quality":{"$ref":"#/components/schemas/Quality"},"regions":{"type":"array","items":{"$ref":"#/components/schemas/LabelledRegion"}},"resources":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"source_url":{"type":"string","format":"uri","description":"URL of the resource from which the dataset was harvested"},"source_url_explainer":{"$ref":"#/components/schemas/SourceUrlExplainer","description":"Additional information when manual action is necessary to find the requested data at `source_url`"},"status":{"$ref":"#/components/schemas/Status"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/LabelledTag"}},"time_ranges":{"type":"array","items":{"$ref":"#/components/schemas/TimeRange"},"description":"Intervals describing the time-like extent of the dataset"},"title":{"type":"string","description":"The mandatory title of the dataset"},"types":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"additionalProperties":false},"DatasetPage":{"allOf":[{"$ref":"#/components/schemas/Dataset"},{"type":"object","required":["accesses"],"properties":{"accesses":{"type":"integer","format":"int64","description":"Number of accesses to this dataset","minimum":0}}}]},"Domain":{"type":"string","description":"Indicates the domain from which the measurments originate.","enum":["Unspecified","Air","Rivers","Groundwater","Geophysics","Radioactivity","Surfacewater","Chemistry","Sea","Soil","Biology","NonionisingRadiation","Water"]},"Findability":{"type":"object","description":"This quality dimension indicates how well this dataset can be found.","required":["title","description","spatial","spatial_score","temporal","keywords","identifier","score"],"properties":{"description":{"type":"number","format":"float","description":"This score indicates the readability of the description in the range 0 (no description) to 1 (easy to understand).\nIt is equivalent to the Flesch - Reading - Ease index but scaled from 0 to 1 instead of the commonly used 0 - 100 scale."},"identifier":{"type":"boolean","description":"This score indicates if a `global_identifier` exists."},"keywords":{"type":"number","format":"float","description":"This score indicates how well the description is matched to keywords.\nIt is given as the ratio of the keywords attached to this dataset\nbelonging to a controlled vocabulary, therefore ranging from 0 (none of\nthe keywords belong to a controlled vocabulary) to 1 (all of the keywords\nbelong to a controlled vocabulary)."},"score":{"type":"number","format":"float","description":"overall score of this quality dimension."},"spatial":{"$ref":"#/components/schemas/QualitySpatial"},"spatial_score":{"type":"number","format":"float","description":"Numeric representation of `spatial` field."},"temporal":{"type":"boolean","description":"This score indicates if temporal information is provided,\neither by the fields `issued` or `modified`\nor by giving detailed information in `time_ranges`."},"title":{"type":"number","format":"float","description":"This score indicates the readability of the title in the range 0 (hard to understand) to 1 (easy to understand).\nIt is equivalent to the Flesch - Reading - Ease index but scaled from 0 to 1 instead of the commonly used 0 - 100 scale."}}},"GlobalIdentifier":{"oneOf":[{"type":"object","required":["Uuid"],"properties":{"Uuid":{"type":"string","format":"uuid"}}},{"type":"object","required":["UuidWithProvider"],"properties":{"UuidWithProvider":{"type":"array","items":{"type":"object"},"maxItems":2,"minItems":2}}},{"type":"object","required":["UrnNbn"],"properties":{"UrnNbn":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"string"}]},"maxItems":2,"minItems":2}}},{"type":"object","required":["Doi"],"properties":{"Doi":{"type":"string"}}},{"type":"object","required":["Other"],"properties":{"Other":{"type":"string"}}},{"type":"object","required":["Url"],"properties":{"Url":{"type":"string","format":"uri"}}},{"type":"object","required":["Evas"],"properties":{"Evas":{"type":"array","items":{"type":"object"},"maxItems":2,"minItems":2}}}],"description":"The optional global identifier of the dataset.\n\n## Usage\nThis identifier is used to reliably find dupliclate datasets over multiple sources.\n\n## Comparison to other standards\n* In sources following the [DCAT standards][vocab-dcat], this is equivalent to\n```text\ndct:guid\n```\nand if this field does not exist, then to\n```text\ndct:identifier\n```\n\nSee [DCAT-AP.de: Erkennung von Dubletten][erkennung-von-dubletten] for further information.\n\n* In sources following the [OGC CWS standard][ogc-cat], this is equivalent to\n```text\nidentificationInfo.MD_DataIdentification.uuid\n```\nand if this field does not exists, then to\n```text\nidentificationInfo.MD_DataIdentification.citation.CI_Citation.identifier.MD_Identifier.code\n```\n\n[vocab-dcat]: https://www.w3.org/TR/vocab-dcat-3/\n[ogc-cat]: https://www.ogc.org/standard/cat/\n[erkennung-von-dubletten]: https://www.dcat-ap.de/def/dcatde/2.0/implRules/#erkennung-von-dubletten"},"HelpShowPage":{"type":"object","required":["help","success","result"],"properties":{"help":{"type":"string"},"result":{"type":"string"},"success":{"type":"boolean"}}},"Interoperability":{"type":"object","description":"This quality dimension indicates how well this dataset can be integrated with other data.","required":["open_file_format","media_type","machine_readable_data","machine_readable_metadata","score"],"properties":{"machine_readable_data":{"type":"boolean","description":"This score indicates whether the dataset is given in a machine readable format."},"machine_readable_metadata":{"type":"boolean","description":"This score indicates whether the metadata of the dataset is given in a machine readable format."},"media_type":{"type":"boolean","description":"This score indicates whether the type of the dataset is stated."},"open_file_format":{"type":"boolean","description":"This score indicates whether the data can be retrieved in an open data format."},"score":{"type":"number","format":"float","description":"overall score of this quality dimension"}}},"LabelledAlternative":{"oneOf":[{"type":"object","required":["Source"],"properties":{"Source":{"type":"object","required":["source","title","url","origins"],"properties":{"origins":{"type":"array","items":{"type":"string"}},"source":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"}}}}},{"type":"object","required":["Language"],"properties":{"Language":{"type":"object","required":["language","title","url"],"properties":{"description":{"type":["string","null"]},"language":{"$ref":"#/components/schemas/LabelledLanguage"},"title":{"type":"string"},"url":{"type":"string"}}}}}]},"LabelledLanguage":{"type":"object","description":"The language used by the dataset","required":["id","path","label"],"properties":{"id":{"$ref":"#/components/schemas/Language"},"label":{"type":"string"},"path":{"type":"string"}}},"LabelledOrganisation":{"oneOf":[{"type":"object","required":["Other"],"properties":{"Other":{"type":"object","required":["name","role"],"properties":{"name":{"type":"string"},"role":{"$ref":"#/components/schemas/OrganisationRole"},"websites":{"type":"array","items":{"type":"string"}}}}}},{"type":"object","required":["WikiData"],"properties":{"WikiData":{"type":"object","required":["identifier","label","role"],"properties":{"identifier":{"type":"integer","format":"int64","minimum":0},"label":{"type":"string"},"role":{"$ref":"#/components/schemas/OrganisationRole"}}}}}],"description":"An organisation affiliated with the dataset"},"LabelledRegion":{"oneOf":[{"type":"object","required":["Other"],"properties":{"Other":{"type":"string"}}},{"type":"object","description":"GeoNames geographical database, c.f. \n\nResolves via ","required":["GeoName"],"properties":{"GeoName":{"type":"object","description":"GeoNames geographical database, c.f. \n\nResolves via ","required":["id","label","url"],"properties":{"id":{"type":"integer","format":"int64","minimum":0},"label":{"type":"string"},"url":{"type":"string"}}}}},{"type":"object","description":"Amtlicher Regionalschlüssel, c.f. \n\nResolves via ","required":["RegionalKey"],"properties":{"RegionalKey":{"type":"object","description":"Amtlicher Regionalschlüssel, c.f. \n\nResolves via ","required":["id","label","url"],"properties":{"id":{"type":"integer","format":"int64","minimum":0},"label":{"type":"string"},"url":{"type":"string"}}}}},{"type":"object","description":"ATKIS Blattschnitteinteilung der Deutschlandkarte, c.f. ","required":["Atkis"],"properties":{"Atkis":{"type":"object","description":"ATKIS Blattschnitteinteilung der Deutschlandkarte, c.f. ","required":["id","label"],"properties":{"id":{"type":"integer","format":"int64","minimum":0},"label":{"type":"string"}}}}},{"type":"object","description":"Watersheds as defined by WISE WFD, c.f. ","required":["Watershed"],"properties":{"Watershed":{"type":"object","description":"Watersheds as defined by WISE WFD, c.f. ","required":["id","label","url"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"url":{"type":"string"}}}}},{"type":"object","description":"Surface waters as defined by WISE WFD, c.f. ","required":["SurfaceWater"],"properties":{"SurfaceWater":{"type":"object","description":"Surface waters as defined by WISE WFD, c.f. ","required":["id","label","url"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"url":{"type":"string"}}}}},{"type":"object","description":"Wasserkörpersteckbriefe as collected by BAfG, c.f. ","required":["Wksb"],"properties":{"Wksb":{"type":"object","description":"Wasserkörpersteckbriefe as collected by BAfG, c.f. ","required":["label","url"],"properties":{"id":{"type":["string","null"]},"label":{"type":"string"},"url":{"type":"string"}}}}}],"description":"A place name affiliated with the dataset"},"LabelledResourceType":{"type":"object","required":["path","label"],"properties":{"label":{"type":"string"},"path":{"type":"string"}}},"LabelledTag":{"oneOf":[{"type":"object","required":["Other"],"properties":{"Other":{"type":"string"}}},{"type":"object","description":"Concept from Umwelthesaurus\n\nResolves via ","required":["Umthes"],"properties":{"Umthes":{"type":"object","description":"Concept from Umwelthesaurus\n\nResolves via ","required":["id","label"],"properties":{"id":{"type":"integer","format":"int64","minimum":0},"label":{"type":"string"}}}}}]},"Language":{"type":"string","enum":["Unknown","Multiple","German","English","Spanish","Albanian","Abkhazian","Bulgarian","Catalan","Czech","Danish","Dutch","Estonian","Faroese","Finnish","French","Georgian","Greek","Croatian","Hungarian","Icelandic","Italian","Latvian","Lithuanian","Macedonian","Maltese","Norwegian","Polish","Portuguese","Romanian","Slovak","Slovenian","Serbian","Swedish","Ukrainian","GermanEasy","LowGerman","Russian","Chinese","Arabic","Armenian","Aromanian","Persian","Turkish"]},"LegalType":{"type":"string","enum":["Act","Ordinance","Regulation"]},"LinkedLicense":{"type":"object","description":"The license under which the dataset is distributed.\n\nHere we provide an overview of our approach to assigning licenses for data records. The decisions made to date are documented here and will be continuously expanded as required.\n\n## Decisions\n\n- In general, we are guided by [DCAT-AP.de](https://www.dcat-ap.de/def/licenses/20210721.html).\n- If information on reserved rights is available in the form of \"all rights reserved\", \"Alle Rechte vorbehalten\" or the copyright symbol ©, [`all-rights-reserved`](https://en.wikipedia.org/wiki/All_rights_reserved) is attributed.\n- If information on reserved rights is available but not clearly specified or in case that there are multiple closed licenses, the license [`other-closed`](https://www.dcat-ap.de/def/licenses/20210721.html#other-closed) is attributed.\n- If there is an unspecified open license, the license [`other-open`](https://www.dcat-ap.de/def/licenses/20210721.html#other-open) is attributed.\n- If there are multiple open licenses, these are recorded as `MixedOpen`.\n- If there are multiple partly open and partly closed or unknown licenses, these are recorded as `MixedClosed`.\n- If information on license rights is unclear or erroneous, `Unknown` is attributed.","required":["path","label"],"properties":{"label":{"type":"string"},"path":{"type":"string"},"url":{"type":["string","null"]}}},"Measurements":{"type":"object","required":["domain","measured_variables","methods"],"properties":{"domain":{"$ref":"#/components/schemas/Domain"},"measured_variables":{"type":"array","items":{"type":"string"},"description":"Indicates which variables are part of the measured data."},"methods":{"type":"array","items":{"type":"string"},"description":"Indicates which method was used to retrieve the data.\n\nThis can be a specific procedure, but can also indicate more generally if the data is measured, estimated or modelled."},"station":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Station"}]}}},"Occur":{"type":"string","enum":["Should","Must","MustNot"]},"OrganisationRole":{"type":"string","enum":["Unknown","Publisher","Operator","Organiser","Management","Provider","Owner","Contributor","Funder","PrincipalInvestigator"]},"Origin":{"type":"object","required":["name","description"],"properties":{"about_url":{"type":["string","null"],"format":"uri","description":"Hyperlink to the about page"},"contact_url":{"type":["string","null"],"format":"uri","description":"Hyperink to the contact page"},"description":{"type":"string","description":"Background information on the data provider"},"email":{"type":["string","null"],"description":"Contact via electronic mail"},"name":{"type":"string","description":"The name of the data provider"}},"additionalProperties":false},"OriginPage":{"type":"object","required":["id","origin"],"properties":{"id":{"type":"string","description":"Path to best-matching origin"},"origin":{"$ref":"#/components/schemas/Origin"}}},"PackageSearchPage":{"type":"object","required":["help","success","result"],"properties":{"help":{"type":"string"},"result":{"$ref":"#/components/schemas/CkanSearchResults"},"success":{"type":"boolean"}}},"PackageShowPage":{"type":"object","required":["help","success","result"],"properties":{"help":{"type":"string"},"result":{"$ref":"#/components/schemas/CkanDataset"},"success":{"type":"boolean"}}},"Person":{"type":"object","description":"A person affiliated with the dataset","required":["name","role"],"properties":{"do_not_filter":{"type":"boolean"},"emails":{"type":"array","items":{"type":"string"},"description":"Addresses to reach this person via electronic mail"},"forms":{"type":"array","items":{"type":"string"},"description":"Addresses to reach this person using a web form"},"name":{"type":"string"},"orcid":{"type":["string","null"],"description":"ORCID associated with the person\n\nThis identifier can be resolved at ."},"role":{"$ref":"#/components/schemas/PersonRole"}},"additionalProperties":false},"PersonRole":{"type":"string","description":"The role of a person in relation to the dataset containing the reference","enum":["Unknown","Contact","Creator","Contributor","Manager"]},"Quality":{"type":"object","description":"These indicators should help the user to judge the relevance of a dataset.\n\nIt follows the categories spelled out in the FAIR principles.\nIt is not a quality assessment of the data themselves, but rather\nindicates the degree to which it is findable and usable.\n\nMany of the fields are based on the ones used by [data.europa.eu](https://data.europa.eu/mqa/methodology)","required":["findability","accessibility","interoperability","reusability","score"],"properties":{"accessibility":{"$ref":"#/components/schemas/Accessibility"},"findability":{"$ref":"#/components/schemas/Findability"},"interoperability":{"$ref":"#/components/schemas/Interoperability"},"reusability":{"$ref":"#/components/schemas/Reusability"},"score":{"type":"number","format":"float","description":"Total score for quality in the range of [0, 1] derived from respective sub-scores."}}},"QualityLandingPage":{"type":"string","description":"This categorical score indicates how precise the landing page leads to the dataset.","enum":["Generic","Specific"]},"QualityLicense":{"type":"string","description":"This categorical score assesses the reusability according to the license type.","enum":["NoInformation","UnclearInformation","ClearlySpecified","ClearlySpecifiedAndFree"]},"QualitySpatial":{"type":"string","description":"This categorical score indicates how precise the regional information is provided.","enum":["NoRegion","RegionOther","BoundingBox","Point","RegionIdentified"]},"ReportingObligation":{"type":"string","enum":["Wrrl","Ospar","Helcom","SoeReport","Nitrat","Prtr"]},"Resource":{"type":"object","description":"A locatable resource attached to the dataset","required":["type","url","direct_link","primary_content"],"properties":{"description":{"type":["string","null"]},"direct_link":{"type":"boolean"},"primary_content":{"type":"boolean"},"type":{"$ref":"#/components/schemas/LabelledResourceType"},"url":{"type":"string","format":"uri"}},"additionalProperties":false},"Reusability":{"type":"object","description":"This quality dimension indicates how well this dataset can be reused.","required":["license","license_score","contact_info","publisher_info","score"],"properties":{"contact_info":{"type":"boolean","description":"This score indicates whether a contact address and/or person is given."},"license":{"$ref":"#/components/schemas/QualityLicense"},"license_score":{"type":"number","format":"float","description":"Numeric representation of `license` field."},"publisher_info":{"type":"boolean","description":"This score indicates whether the publisher is stated."},"score":{"type":"number","format":"float","description":"overall score of this quality dimension"}}},"ScoredDataset":{"allOf":[{"$ref":"#/components/schemas/UniquelyIdentifiedDataset"},{"type":"object","required":["score"],"properties":{"score":{"type":"number","format":"float","description":"Score of this dataset by the search engine based on the given search parameters"}}}]},"SearchAllParams_StructQuery":{"type":"object","required":["query"],"properties":{"bounding_box_contains":{"type":"boolean","description":"Whether the bounding box must fully contain instead of just intersect the bounding box of the dataset"},"bounding_box_east":{"type":["number","null"],"format":"double","description":"Maximum longitude of results using WGS84","maximum":180,"minimum":-180},"bounding_box_north":{"type":["number","null"],"format":"double","description":"Maximum latitude of results using WGS84","maximum":90,"minimum":-90},"bounding_box_south":{"type":["number","null"],"format":"double","description":"Minimum latitude of results using WGS84","maximum":90,"minimum":-90},"bounding_box_west":{"type":["number","null"],"format":"double","description":"Minimum longitude of results using WGS84","maximum":180,"minimum":-180},"language":{"$ref":"#/components/schemas/SearchLanguage","description":"Language used to interpret query in"},"query":{"type":"array","items":{"$ref":"#/components/schemas/Clause"},"description":"Structured representation of a query as a list of clauses\n\nAn empty list or a single empty clause will be interpreted as the all query."},"sampling_fraction":{"type":["number","null"],"format":"float","description":"If set, randomly yields only the given fraction of results."},"time_range_contains":{"type":"boolean","description":"Whether the time range must fully contain instead of just intersect the time range associated with the dataset"},"time_range_from":{"type":["string","null"],"format":"date","description":"Lower bound of time range"},"time_range_until":{"type":["string","null"],"format":"date","description":"Upper bound of time range"}}},"SearchLanguage":{"type":"string","enum":["de","en"]},"SearchPage_StructQuery":{"type":"object","required":["count","pages","results","types","topics","origins","licenses","languages","resource_types","spatial_clusters","terms","similar_terms","related_terms"],"properties":{"count":{"type":"integer","description":"Total number of results found","minimum":0},"languages":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","format":"int64","minimum":0}]},"description":"Hierarchical grouping of languages"},"licenses":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","format":"int64","minimum":0}]},"description":"Hierarchical grouping of licenses"},"origins":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","format":"int64","minimum":0}]},"description":"Hierarchical grouping of origin"},"pages":{"type":"integer","description":"Total number of pages","minimum":0},"related_terms":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"resource_types":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","format":"int64","minimum":0}]},"description":"Hierarchical grouping of resource types"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ScoredDataset"}},"similar_terms":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"string"}]}},"spatial_clusters":{"type":"array","items":{"$ref":"#/components/schemas/SpatialCluster"}},"terms":{"type":"array","items":{"type":"string"}},"topics":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","format":"int64","minimum":0}]},"description":"Hierarchical grouping of tags"},"types":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","format":"int64","minimum":0}]},"description":"Hierarchical grouping of types"}}},"SearchPage_TextQuery":{"type":"object","required":["count","pages","results","types","topics","origins","licenses","languages","resource_types","spatial_clusters","terms","similar_terms","related_terms"],"properties":{"count":{"type":"integer","description":"Total number of results found","minimum":0},"languages":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","format":"int64","minimum":0}]},"description":"Hierarchical grouping of languages"},"licenses":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","format":"int64","minimum":0}]},"description":"Hierarchical grouping of licenses"},"origins":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","format":"int64","minimum":0}]},"description":"Hierarchical grouping of origin"},"pages":{"type":"integer","description":"Total number of pages","minimum":0},"related_terms":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"resource_types":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","format":"int64","minimum":0}]},"description":"Hierarchical grouping of resource types"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ScoredDataset"}},"similar_terms":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"string"}]}},"spatial_clusters":{"type":"array","items":{"$ref":"#/components/schemas/SpatialCluster"}},"terms":{"type":"array","items":{"type":"string"}},"topics":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","format":"int64","minimum":0}]},"description":"Hierarchical grouping of tags"},"types":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string"},{"type":"integer","format":"int64","minimum":0}]},"description":"Hierarchical grouping of types"}}},"SearchParams_StructQuery":{"type":"object","properties":{"bounding_box_contains":{"type":"boolean","description":"Whether the bounding box must fully contain instead of just intersect the bounding box of the dataset"},"bounding_box_east":{"type":["number","null"],"format":"double","description":"Maximum longitude of results using WGS84","examples":[15.02],"maximum":180,"minimum":-180},"bounding_box_north":{"type":["number","null"],"format":"double","description":"Maximum latitude of results using WGS84","examples":[54.98],"maximum":90,"minimum":-90},"bounding_box_south":{"type":["number","null"],"format":"double","description":"Minimum latitude of results using WGS84","examples":[47.3],"maximum":90,"minimum":-90},"bounding_box_spatial_clusters":{"type":"boolean","description":"Whether to aggregate the results within the given bounding box into spatial clusters"},"bounding_box_west":{"type":["number","null"],"format":"double","description":"Minimum longitude of results using WGS84","examples":[5.99],"maximum":180,"minimum":-180},"language":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/SearchLanguage","description":"Language used to interpret query in (available are \"de\" for German and \"en\" for English)"}]},"languages_root":{"type":"string","description":"Entry point for faceted search of languages","examples":["/Deutsch"]},"licenses_root":{"type":"string","description":"Entry point for faceted search of licenses","examples":["/offen"]},"origin_weights":{"type":"array","items":{"type":"string"},"description":"Enables selectively weighing the given origins\n\nThis can be given multiple times and takes the form `^`\nwhere `` can be a prefix, so for example\n\n```text\n&origin_weights=/Bund^0.5&origin_weights=/Land^2.0\n```\n\nwill half the score of all results with origins starting with `/Bund`\nand double the score of all results with origins starting with `/Land`."},"origins_root":{"type":"string","description":"Entry point for faceted search of origins","examples":["/Land"]},"page":{"type":"integer","description":"Return results from the given page","examples":[3],"minimum":0},"query":{"type":"array","items":{"$ref":"#/components/schemas/Clause"},"description":"Structured representation of a query as a list of clauses\n\nAn empty list or a single empty clause will be interpreted as the all query."},"resource_types_root":{"type":"string","description":"Entry point for faceted search of resources types","examples":["/Datei"]},"results_per_page":{"type":"integer","description":"Number of results per page","examples":[7],"maximum":100,"minimum":1},"time_range_contains":{"type":"boolean","description":"Whether the time range must fully contain instead of just intersect the time range associated with the dataset"},"time_range_from":{"type":["string","null"],"format":"date","description":"Lower bound of time range (format: YYYY-MM-DD)","examples":["2005-05-15"]},"time_range_until":{"type":["string","null"],"format":"date","description":"Upper bound of time range (format: YYYY-MM-DD)","examples":["2024-10-20"]},"topics_root":{"type":"string","description":"Entry point for faceted search of tags","examples":["/Boden"]},"types_root":{"type":"string","description":"Entry point for faceted search of types (example query \"/Taxon\", which gives all entries related to the type Taxon)","examples":["/Taxon"]}}},"SourceUrlExplainer":{"oneOf":[{"type":"string","enum":["None"]},{"type":"object","required":["Informational"],"properties":{"Informational":{"type":"string"}}},{"type":"object","required":["CopyTitle"],"properties":{"CopyTitle":{"type":"string"}}},{"type":"object","required":["CopyStationId"],"properties":{"CopyStationId":{"type":"string"}}},{"type":"object","required":["CopyScientificName"],"properties":{"CopyScientificName":{"type":"string"}}}]},"SpatialCluster":{"type":"object","required":["position","bounding_box","count"],"properties":{"bounding_box":{"type":"array","items":{"$ref":"#/components/schemas/BoundingBox"}},"count":{"type":"integer","minimum":0},"position":{"$ref":"#/components/schemas/Corner"}}},"Station":{"type":"object","description":"Indicates properties of the point of measurement where the data was collected.","required":["reporting_obligations"],"properties":{"id":{"type":["string","null"]},"measurement_frequency":{"type":["string","null"]},"reporting_obligations":{"type":"array","items":{"$ref":"#/components/schemas/ReportingObligation"}}}},"Status":{"type":"string","description":"Status of data described in dataset.\n Corresponds to https://standards.iso.org/iso/19139/resources/gmxCodelists.xml#MD_ProgressCode used in CSW","enum":["Active","Obsolete","Planned","UnderDevelopment","Inactive"]},"StructQuery":{"type":"array","items":{"$ref":"#/components/schemas/Clause"},"description":"Structured representation of a query as a list of clauses\n\nAn empty list or a single empty clause will be interpreted as the all query."},"Taxon":{"type":"object","required":["scientific_name","common_names"],"properties":{"class":{"type":["string","null"],"description":""},"common_names":{"type":"array","items":{"type":"string"},"description":""},"conservation_status":{"type":["string","null"],"description":""},"family":{"type":["string","null"],"description":""},"genus":{"type":["string","null"],"description":""},"kingdom":{"type":["string","null"],"description":""},"order":{"type":["string","null"],"description":""},"phylum":{"type":["string","null"],"description":""},"scientific_name":{"type":"string","description":""},"taxonomic_status":{"type":["string","null"],"description":""}}},"TextQuery":{"type":"string"},"TextType":{"type":"string","description":"Inidcates the kind of text provided by the dataset.","enum":["Unspecified","OfficialFile","Manual","Report","Publication","BlogPost","PressRelease","News","Editorial","Booklet"]},"TimeRange":{"type":"object","description":"Interval defined by its first and last dates","required":["from","until"],"properties":{"from":{"type":"string","format":"date"},"until":{"type":"string","format":"date"}}},"TimestampedCounts":{"allOf":[{"$ref":"#/components/schemas/Counts"},{"type":"object","required":["timestamp"],"properties":{"timestamp":{"type":"string","format":"date-time"}}}]},"TopNDataset":{"allOf":[{"$ref":"#/components/schemas/UniquelyIdentifiedDataset"},{"type":"object","required":["accesses"],"properties":{"accesses":{"type":"integer","format":"int64","minimum":0}}}]},"TopNTag":{"type":"object","required":["tag","queries","datasets","score"],"properties":{"datasets":{"type":"integer","minimum":0},"queries":{"type":"integer","format":"int64","minimum":0},"score":{"type":"number","format":"float"},"tag":{"type":"array","items":{"$ref":"#/components/schemas/LabelledTag"}}}},"Type":{"oneOf":[{"type":"string","description":"","enum":["Event"]},{"type":"string","description":"","enum":["LearningResource"]},{"type":"object","description":"","required":["Taxon"],"properties":{"Taxon":{"$ref":"#/components/schemas/Taxon","description":""}}},{"type":"object","required":["Measurements"],"properties":{"Measurements":{"$ref":"#/components/schemas/Measurements"}}},{"type":"string","enum":["SupportProgram"]},{"type":"string","enum":["MapService"]},{"type":"string","description":"","enum":["Uvp"]},{"type":"object","required":["Text"],"properties":{"Text":{"$ref":"#/components/schemas/TextType"}}},{"type":"string","description":"","enum":["Software"]},{"type":"string","description":"","enum":["Image"]},{"type":"string","description":"","enum":["Dataset"]},{"type":"object","description":"","required":["Legal"],"properties":{"Legal":{"$ref":"#/components/schemas/LegalType","description":""}}},{"type":"string","description":"","enum":["Video"]},{"type":"string","description":"","enum":["Audio"]},{"type":"string","description":"","enum":["Form"]},{"type":"object","required":["ChemicalCompound"],"properties":{"ChemicalCompound":{"$ref":"#/components/schemas/ChemicalCompound"}}},{"type":"object","required":["Wrrl"],"properties":{"Wrrl":{"$ref":"#/components/schemas/Wrrl"}}}],"description":"This is the categorization of the types assigned to each data set.\n\nThe categorization uses the metadata terms of the [Dublin Core™ Metadata Initiative](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/) where suitable and extended here where necessary."},"UniquelyIdentifiedDataset":{"allOf":[{"$ref":"#/components/schemas/Dataset"},{"type":"object","required":["source","id"],"properties":{"id":{"type":"string","description":"Identifier of the dataset which is unique for this harvester"},"source":{"type":"string","description":"Name of the harvester creating this dataset"}}}]},"Wrrl":{"type":"object","properties":{"measure_id":{"type":["string","null"]},"period":{"type":["integer","null"],"format":"int32","minimum":0},"water_body_id":{"type":["string","null"]}}}}}}