Abstrakt

Cílem tohoto dokumentu je specifikovat rozhraní lokálních katalogů otevřených dat (LKOD) pro jejich harvestování Národním katalogem otevřených dat (NKOD). Stejná specifikace platí i pro datový model NKOD a data poskytovaná z NKOD v podobě souborů ke stažení či SPARQL endpointu. Nejprve je specifikován datový model katalogizačního záznamu. Poté jsou specifikovány 3 varianty rozhraní pro harvestaci. Dvě varianty jsou založeny na standardu DCAT-AP 2.0.1, jedna využívá SPARQL endpoint a jedna specifikuje variantu uložení záznamů v souborech, bez použití SPARQL endpointu. Varianta CKAN API je podporována pouze v režimu zpětné kompatibility a neumožňuje vyplnění všech položek záznamu.

Úvod

Provozování lokálního katalogu otevřených dat (LKOD) je jedním ze způsobů zajištění katalogizace dat v Národním katalogu otevřených dat (NKOD), což je jedna ze zákonných podmínek pro to, aby data mohla být nazývána otevřenými daty. Tento způsob katalogizace je vhodný pro střední a větší organizace, u kterých se dá předpokládat katalogizace většího množství datových sad či častější aktualizace jejich metadat.

Diagram datového modelu rozhraní katalogů otevřených dat
Diagram datového modelu rozhraní katalogů otevřených dat. Šedě podbarvené části jsou specifikovány číselníky.

Co je nového

Oproti doporučení ze 4.4.2019 jsou v této OFN následující změny:

  1. Přechod ze standardu DCAT-AP 1.2 na DCAT-AP 2.0.1
  2. Podpora pro textové položky katalogizačních záznamů jak v češtině, tak v angličtině
  3. Podpora pro registraci datových služeb, které typicky představují způsob přístupu k datové sadě pomocí API
  4. Podpora pro rozšířenou specifikaci souvisejícího geografického území datové sady
  5. Podpora pro odkaz na specifikaci datové sady, např. otevřenou formální normu
  6. Podpora pro odkaz na zastřešující datovou sadu datové série
  7. Podpora pro specifikaci časového rozlišení datové sady
  8. Podpora pro specifikaci prostorového rozlišení datové sady v metrech
  9. Podpora pro specifikaci více témat datové sady
  10. Podpora pro specifikaci media typu kompresního formátu distribuce datové sady
  11. Podpora pro specifikaci media typu balíčkovacího formátu distribuce datové sady
  12. Změna predikátů pro časové pokrytí ze schema:startDate a schema:endDate na dcat:startDate a dcat:endDate
  13. Změna reprezentace e-mailu kontaktního bodu z řetězce na IRI dle vCard Ontology
  14. Podpora formátu JSON-LD v rozhraní DCAT-AP Dokumenty

Položky metadatového záznamu

V této sekci jsou popsány položky, které mohou být evidované v Národním katalogu otevřených dat (NKOD) pro každou datovou sadu a její distribuci. Položky se řídí standardem DCAT Application Profile for data portals in Europe Version 2.0.1 (DCAT-AP 2.0.1). Jedná se o standard založený na propojených datech, předpokládá se tedy znalost Otevřené formální normy Propojená data.

DCAT-AP 2.0.1 rozlišuje tři základní typy entit. Datovou sadu, její distribuci a datovou službu. Metadata datové sady ji popisují bez ohledu na konkrétní reprezentaci jejích dat. Ta je popsána jako distribuce datové sady, která reprezentuje buď soubor ke stažení, nebo odkazuje na datovou službu, přes kterou jsou data k dispozici. Distribucí může mít datová sada více, lišit se ale mohou pouze formátem souboru ke stažení (např. CSV či JSON) či způsobem zpřístupnění (soubor ke stažení či datová služba). Obsahově by distribuce měly být ekvivalentní.

Použité prefixy

V popisu položek a rozhraní budou použity následující prefixy slovníků.

Pro přehlednost zápisu budou použity ještě následující prefixy zkracující IRI vzorových entit.

Třída: Katalog

Jméno
Katalog
Popis
Třída reprezentující datový katalog. Odpovídá třídě dcat:Catalog.
Třída
katalog: a dcat:Catalog .

Název

Jméno
Název
Popis
Tato vlastnost obsahuje název datového katalogu. Odpovídá vlastnosti dct:title.
Vlastnost
název, dct:title
Typ
Text
Povinnost
Povinná
Příklad
katalog: dct:title "Katalog otevřených dat Ministerstva dopravy"@cs, "Open Data Catalog of the Ministry of Transport"@en .

Popis

Jméno
Popis
Popis
Tato vlastnost obsahuje volný text s popisem datového katalogu. Odpovídá vlastnosti dct:description.
Vlastnost
popis, dct:description
Typ
Text
Povinnost
Povinná
Příklad
katalog: dct:description "Otevřená data Ministerstva dopravy. Obsahuje datové sady o jízdních řádech a liniových vedeních veřejné dopravy."@cs, "Open data of the Ministry of Transport. It contains datasets regarding timetables of public transport."@en .

Poskytovatel

Jméno
Poskytovatel
Popis
Poskytovatel datového katalogu. Odpovídá vlastnosti dct:publisher.
Vlastnost
poskytovatel, dct:publisher
Typ
IRI OVM z Registru práv a povinností (RPP).
Povinnost
Povinná
Příklad
katalog: dct:publisher <https://rpp-opendata.egon.gov.cz/odrpp/zdroj/orgán-veřejné-moci/66003008> .

Kontaktní bod - jméno a email

Jméno
Kontaktní bod - jméno a email
Popis
Tato vlastnost obsahuje kontaktní informace, které mohou být využity pro zasílání připomínek ke katalogu. Odpovídá vlastnosti dcat:contactPoint.
Vlastnost
kontaktní_bod, dcat:contactPoint
Typ
Entita podtypu vcard:Kind s vlastnostmi vcard:fn a vcard:hasEmail.
Povinnost
Nepovinná
Příklad
katalog: dcat:contactPoint správce: .

správce: a vcard:Individual ;
         vcard:fn "Jan Novák"@cs ;
         vcard:hasEmail <mailto:jan.novak@organizace.cz> .

Domovská stránka

Jméno
Domovská stránka
Popis
Tato vlastnost odkazuje na domovskou stránku lokálního katalogu, kam mohou chodit uživatelé. Odpovídá vlastnosti foaf:homepage.
Vlastnost
domovská_stránka, foaf:homepage
Typ
URL webové stránky.
Povinnost
Nepovinná
Příklad
katalog: foaf:homepage <https://data.gov.cz/> .

Vazba: Datová sada

Jméno
Datová sada
Popis
Tato vlastnost odkazuje na datové sady v katalogu. Odpovídá vlastnosti dcat:dataset.
Vlastnost
datová_sada, dcat:dataset
Typ
Entita typu datová sada.
Povinnost
Povinná
Příklad
katalog: dcat:dataset sada: .

Třída: Datová sada

Jméno
Datová sada
Popis
Klíčová třída reprezentující poskytovanou informaci. Odpovídá třídě dcat:Dataset.
Třída
sada: a dcat:Dataset .

Název

Jméno
Název
Popis
Tato vlastnost obsahuje název datové sady. Odpovídá vlastnosti dct:title.
Vlastnost
název, dct:title
Typ
Text
Povinnost
Povinná
Příklad
sada: dct:title "Kontroly plnění povinností zaměstnavatelů v oblasti sociálního zabezpečení"@cs, "Duty fulfillment inspections in the area of social security"@en .

Popis

Jméno
Popis
Popis
Tato vlastnost obsahuje volný text s popisem datové sady. Odpovídá vlastnosti dct:description.
Vlastnost
popis, dct:description
Typ
Text
Povinnost
Povinná
Příklad
sada: dct:description "Statistika kontrol plnění povinností zaměstnavatelů v oblasti sociálního zabezpečení od roku 2009"@cs, "Social security statistics for 2009"@en .

Poskytovatel

Jméno
Poskytovatel
Popis
Poskytovatel datové sady. Odpovídá vlastnosti dct:publisher.
Vlastnost
poskytovatel, dct:publisher
Typ
IRI OVM z Registru práv a povinností (RPP).
Povinnost
Povinná
Příklad
sada: dct:publisher .

Téma

Jméno
Téma
Popis
Tato vlastnost odkazuje na kategorii či téma datové sady. Datová sada může být popsána více tématy. Odpovídá vlastnosti dcat:theme. Dle DCAT-AP 2.0.1 musí být alespoň jedno téma z evropského číselníku datových témat.
Vlastnost
téma, dcat:theme
Typ
Několik IRI.
Povinnost
Povinná
Příklad
sada: dcat:theme <http://publications.europa.eu/resource/authority/data-theme/TRAN> .

Periodicita aktualizace

Jméno
Periodicita aktualizace
Popis
Tato vlastnost odkazuje na frekvenci, se kterou je datová sada aktualizována. Odpovídá vlastnosti dct:accrualPeriodicity. Dle DCAT-AP 2.0.1 jsou hodnoty z evropského číselníku frekvencí.
Vlastnost
periodicita_aktualizace, dct:accrualPeriodicity
Typ
IRI položky z evropského číselníku frekvencí
Povinnost
Povinná
Příklad
sada: dct:accrualPeriodicity <http://publications.europa.eu/resource/authority/frequency/MONTHLY> .

Klíčová slova

Jméno
Klíčová slova
Popis
Tato vlastnost obsahuje klíčové slovo nebo značku popisující datovou sadu. Odpovídá vlastnosti dcat:keyword.
Vlastnost
klíčové_slovo, dcat:keyword
Typ
Text, opakovaná vlastnost.
Povinnost
Povinná
Příklad
sada: dcat:keyword "kontrola"@cs, "statistika"@cs, "inspection"@en, "statistics"@en .

Související geografické území - prvek z RÚIAN

Jméno
Související geografické území - prvek z RÚIAN
Popis
Tato vlastnost odkazuje na územní prvek RÚIAN pokrytý datovou sadou. Datová sada může pokrývat více územních prvků RÚIAN. Odpovídá vlastnosti dct:spatial.
Vlastnost
prvek_rúian, dct:spatial
Typ
IRI územního prvku RÚIAN
Povinnost
Povinná
Příklad
sada: dct:spatial <https://linked.cuzk.cz/resource/ruian/stat/1> .

Související geografické území

Jméno
Související geografické území
Popis
Tato vlastnost odkazuje na geografickou oblast pokrytou datovou sadou. Datová sada může být popsána více geografickými oblastmi. Odpovídá vlastnosti dct:spatial.
Vlastnost
geografické_území, dct:spatial
Typ
IRI položek z evropských číselníků zemí, kontinentů, míst nebo IRI objektu z Geonames.
Povinnost
Nepovinná
Příklady
sada: dct:spatial <http://publications.europa.eu/resource/authority/continent/EUROPE> .
sada: dct:spatial <https://sws.geonames.org/6290257/> .

Časové pokrytí

Jméno
Časové pokrytí
Popis
Tato vlastnost odkazuje na časový úsek pokrytý datovou sadou. Odpovídá vlastnosti dct:temporal.
Vlastnost
časové_pokrytí, dct:temporal
Typ
Entita typu dct:PeriodOfTime s vlastnostmi dcat:startDate a dcat:endDate, které mají datový typ xsd:date.
Povinnost
Nepovinná
Příklad
sada: dct:temporal čas: .

čas: dcat:startDate "2009-01-01"^^xsd:date ;
     dcat:endDate "2017-12-31"^^xsd:date .

Kontaktní bod - jméno a email

Jméno
Kontaktní bod - jméno a email
Popis
Tato vlastnost obsahuje kontaktní informace, které mohou být využity pro zasílání připomínek k datové sadě. Odpovídá vlastnosti dcat:contactPoint.
Vlastnost
kontaktní_bod, dcat:contactPoint
Typ
Entita podtypu vcard:Kind s vlastnostmi vcard:fn a vcard:hasEmail.
Povinnost
Nepovinná
Příklad
sada: dcat:contactPoint kontakt: .

kontakt: a vcard:Individual ;
         vcard:fn "Jan Novák"@cs ;
         vcard:hasEmail <mailto:jan.novak@organizace.cz> .

Odkaz na dokumentaci

Jméno
Odkaz na dokumentaci
Popis
Tato vlastnost odkazuje na stránku nebo dokument o datové sadě. Odpovídá vlastnosti foaf:page.
Vlastnost
dokumentace, foaf:page
Typ
URL webové stránky dokumentace.
Povinnost
Nepovinná
Příklad
sada: foaf:page <https://data.cssz.cz/documentation/kontroly-plneni-povinnosti-zamestnavatelu-v-oblasti-socialniho-zabezpeceni> .

Odkaz na specifikaci

Jméno
Odkaz na specifikaci
Popis
Tato vlastnost odkazuje na specifikaci, jíž se datová sada řídí. Takovou specifikací jsou zejména Otevřené formální normy. Odpovídá vlastnosti dct:conformsTo.
Vlastnost
specifikace, dct:conformsTo
Typ
URL specifikace.
Povinnost
Nepovinná
Příklad
sada: dct:conformsTo <https://ofn.gov.cz/turistické-cíle/2020-07-01/> .

Klasifikace dle EuroVoc

Jméno
Klasifikace dle EuroVoc
Popis
Tato vlastnost odkazuje na kategorii či téma datové sady dle EuroVoc. Datová sada může být popsána více tématy. Odpovídá vlastnosti dcat:theme.
Vlastnost
koncept_euroVoc, dcat:theme
Typ
IRI konceptu z evropského tezauru EuroVoc
Povinnost
Nepovinná
Příklad
sada: dcat:theme <http://eurovoc.europa.eu/1001>, <http://eurovoc.europa.eu/4050> .

Prostorové rozlišení v metrech

Jméno
Prostorové rozlišení v metrech
Popis
Tato vlastnost určuje prostorové rozlišení dat v datové sadě v metrech. Jedná se o nejmenší prostorový rozdíl v datové sadě. Odpovídá vlastnosti dcat:spatialResolutionInMeters.
Vlastnost
prostorové_rozlišení_v_metrech, dcat:spatialResolutionInMeters
Typ
Desetinné číslo
Povinnost
Nepovinná
Příklad
0.5

Časové rozlišení

Jméno
Časové rozlišení
Popis
Tato vlastnost určuje časové rozlišení dat v datové sadě. Jedná se o nejmenší časový rozdíl v datové sadě. Odpovídá vlastnosti dcat:temporalResolution.
Vlastnost
časové_rozlišení, dcat:temporalResolution
Typ
xsd:duration
Povinnost
Nepovinná
Příklad
P1D

Vazba: Je součástí

Jméno
Je součástí
Popis
Tato vlastnost odkazuje na zastřešující datovou sadu datové série, jejíž je tato datová sada součástí. Odpovídá vlastnosti dct:isPartOf.
Vlastnost
je_součástí, dct:isPartOf
Typ
IRI zastřešující datové sady.
Povinnost
Nepovinná
Příklady
sada: dct:isPartOf <https://datový.katalog.cz/zdroj/datové-sady/zastřešující> .

Vazba: Distribuce datové sady

Jméno
Distribuce datové sady
Popis
Tato vlastnost odkazuje z datové sady na její distribuci. Odpovídá vlastnosti dcat:distribution.
Vlastnost
distribuce, dcat:distribution
Typ
Entita typu distribuce datové sady.
Povinnost
Povinná, pokud se nejedná o zastřešující datovou sadu datové série.
Příklad
sada: dcat:distribution distribuce: .

Třída: Distribuce datové sady

Jméno
Distribuce datové sady
Popis
Fyzická podoba datové sady v konkrétním formátu nebo jako konkrétní služba, nikdy obojí. Odpovídá třídě dcat:Distribution.
Třída
distribuce: a dcat:Distribution.

Specifikace podmínek užití

Jméno
Specifikace podmínek užití
Popis
Tato vlastnost odkazuje na strukturovaný popis podmínek užití této distribuce datové sady. Hodnoty se řídí návodem na stanovení podmínek užití.
Vlastnost
podmínky_užití, pu:specifikace
Typ
Entita typu pu:Specifikace s vlastnostmi pu:autorské-dílo, pu:databáze-jako-autorské-dílo, pu:databáze-chráněná-zvláštními-právy a pu:osobní-údaje.
Povinnost
Povinná
Příklad
distribuce: pu:specifikace podmínky: .

podmínky: a pu:Specifikace ;
          pu:autorské-dílo <https://data.gov.cz/podmínky-užití/neobsahuje-autorská-díla/> ;
          pu:databáze-jako-autorské-dílo <https://data.gov.cz/podmínky-užití/není-autorskoprávně-chráněnou-databází/> ;
          pu:databáze-chráněná-zvláštními-právy <https://data.gov.cz/podmínky-užití/není-chráněna-zvláštním-právem-pořizovatele-databáze/> ;
          pu:osobní-údaje <https://data.gov.cz/podmínky-užití/neobsahuje-osobní-údaje/> .

Odkaz na stažení souboru

Jméno
Odkaz na stažení souboru
Popis
Tato vlastnost obsahuje URL, které je přímým odkazem na stažitelný soubor v daném formátu. Odpovídá vlastnosti dcat:downloadURL.
Vlastnost
soubor_ke_stažení, dcat:downloadURL
Typ
URL souboru ke stažení.
Povinnost
Povinná pro soubor ke stažení
Příklad
distribuce: dcat:downloadURL <https://data.cssz.cz/dump/kontroly-plneni-povinnosti-zamestnavatelu-v-oblasti-socialniho-zabezpeceni.csv> .

Přístupové URL

Jméno
Přístupové URL
Popis
Tato vlastnost obsahuje URL, pomocí kterého se lze dostat k distribuci datové sady. Odpovídá vlastnosti dcat:accessURL. Pro účely katalogů otevřených dat v ČR je hodnota této vlastnosti buďto stejná jako odkaz na stažení souboru v případě distribuce reprezentující soubor ke stažení, nebo stejná jako přístupový bod v případě distribuce reprezentující datovou službu.
Vlastnost
přístupové_url, dcat:accessURL
Typ
Přístupové URL distribuce datové sady.
Povinnost
Povinná
Příklad
distribuce: dcat:accessURL <https://data.cssz.cz/dump/kontroly-plneni-povinnosti-zamestnavatelu-v-oblasti-socialniho-zabezpeceni.csv> .

Formát souboru ke stažení

Jméno
Formát souboru ke stažení
Popis
Tato vlastnost odkazuje na typ souboru s distribucí. Odpovídá vlastnosti dct:format. Dle DCAT-AP 2.0.1 jsou hodnoty z evropského číselníku typů souboru.
Vlastnost
formát, dct:format
Typ
IRI položky z evropského číselníku typů souboru
Povinnost
Povinná pro soubor ke stažení
Příklad
distribuce: dct:format <http://publications.europa.eu/resource/authority/file-type/CSV> .

Media type souboru ke stažení

Jméno
Media type souboru ke stažení
Popis
Tato vlastnost odkazuje na typ média distribuce tak, jak je definováno v oficiálním rejstříku typů médií spravovaném IANA [[!IANA-MEDIA-TYPES]]. Odpovídá vlastnosti dcat:mediaType.
Vlastnost
typ_média, dcat:mediaType
Typ
IRI Media type z rejstříku IANA.
Povinnost
Povinná pro soubor ke stažení
Příklad
distribuce: dcat:mediaType <http://www.iana.org/assignments/media-types/text/csv> .

Odkaz na strojově čitelné schéma souboru ke stažení

Jméno
Odkaz na strojově čitelné schéma souboru ke stažení
Popis
Tato vlastnost odkazuje na ustanovené schéma, jímž se popisovaná distribuce řídí. Odpovídá vlastnosti dct:conformsTo.
Vlastnost
schéma, dct:conformsTo
Typ
URL schématu.
Povinnost
Nepovinná
Příklad
distribuce: dct:conformsTo <https://data.cssz.cz/dump/kontroly-plneni-povinnosti-zamestnavatelu-v-oblasti-socialniho-zabezpeceni-schema.json> .

Media type kompresního formátu

Jméno
Media type použitého kompresního formátu souboru ke stažení
Popis
Tato vlastnost odkazuje na media typ kompresního formátu souboru ke stažení tak, jak je definováno v oficiálním rejstříku typů médií spravovaném IANA [[!IANA-MEDIA-TYPES]]. Kompresní formát určuje techniku použitou ke zmenšení velikosti jednoho souboru ke stažení. Odpovídá vlastnosti dcat:compressFormat.
Vlastnost
typ_média_komprese, dcat:compressFormat
Typ
IRI Media type z rejstříku IANA.
Povinnost
Nepovinná
Příklad
distribuce: dcat:compressFormat <http://www.iana.org/assignments/media-types/application/zip> .

Media type balíčkovacího formátu

Jméno
Media type použitého balíčkovacího formátu souboru ke stažení
Popis
Tato vlastnost odkazuje na media typ balíčkovacího formátu souboru ke stažení tak, jak je definováno v oficiálním rejstříku typů médií spravovaném IANA [[!IANA-MEDIA-TYPES]]. Balíčkovací formát určuje techniku použitou k zabalení více souborů do jednoho. Odpovídá vlastnosti dcat:packageFormat.
Vlastnost
typ_média_balíčku, dcat:packageFormat
Typ
IRI Media type z rejstříku IANA.
Povinnost
Nepovinná
Příklad
distribuce: dcat:packageFormat <http://www.iana.org/assignments/media-types/application/zip> .

Název distribuce datové sady

Jméno
Název distribuce datové sady
Popis
Tato vlastnost obsahuje název distribuce. Odpovídá vlastnosti dct:title.
Vlastnost
název, dct:title
Typ
Text
Povinnost
Nepovinná
Příklad
distribuce: dct:title "Kontroly plnění povinností zaměstnavatelů v oblasti sociálního zabezpečení v CSV."@cs, "CSV representation of inspections in the area of social security."@en .

Vazba: přístupová služba

Jméno
Přístupová služba
Popis
Datová služba zpřístupňující distribuci datové sady. Odpovídá vlastnosti dcat:accessService.
Vlastnost
přístupová_služba, dcat:accessService
Typ
Entita typu datová služba.
Povinnost
Povinná pro datovou službu
Příklad
distribuce: dcat:accessService služba: .

Třída: Datová služba

Jméno
Datová služba
Popis
Třída reprezentující datovou službu zpřístupňující data datové sady. Odpovídá třídě dcat:DataService.
Třída
služba: a dcat:DataService .

Název

Jméno
Název
Popis
Tato vlastnost obsahuje název datové služby. Odpovídá vlastnosti dct:title.
Vlastnost
název, dct:title
Typ
Text
Povinnost
Povinná
Příklad
služba: dct:title "SPARQL endpoint České správy sociálního zabezpečení"@cs, "Czech Social Security Administration SPARQL endpoint"@en .

Přístupový bod

Jméno
Přístupový bod
Popis
Tato vlastnost obsahuje URL přístupového bodu datové služby. Odpovídá vlastnosti dcat:endpointURL.
Vlastnost
přístupový_bod, dcat:endpointURL
Typ
URL
Povinnost
Povinná
Příklad
https://data.cssz.cz/sparql

Odkaz na specifikaci

Jméno
Odkaz na specifikaci
Popis
Tato vlastnost odkazuje na specifikaci, jíž se datová služba řídí. Takovou specifikací je například SPARQL. Odpovídá vlastnosti dct:conformsTo.
Vlastnost
specifikace, dct:conformsTo
Typ
URL specifikace.
Povinnost
Nepovinná
Příklad
služba: dct:conformsTo <https://www.w3.org/TR/sparql11-query/> .

Popis přístupového bodu

Jméno
Popis přístupového bodu
Popis
Tato vlastnost obsahuje URL popisu přístupového bodu datové služby. Odpovídá vlastnosti dcat:endpointDescription.
Vlastnost
popis_přístupového_bodu, dcat:endpointDescription
Typ
URL
Povinnost
Nepovinná
Příklad
https://data.cssz.cz/sparql

Rozhraní DCAT-AP SPARQL Endpoint

Toto rozhraní předpokládá, že metadata datových sad dle této specifikace jsou uložena a přístupná ve SPARQL endpointu. Po registraci tohoto SPARQL endpointu se na něm NKOD zeptá nejprve na seznam instancí třídy dcat:Dataset, a poté se po skupinách bude ptát na povinné, nepovinné i další položky jednotlivých datových sad dle této specifikace a specifikace DCAT-AP 2.0.1. Jedná se o nejjednodušší způsob registrace lokálního katalogu otevřených dat.

Příklady lokálních katalogů typu SPARQL endpoint

V této sekci uvádíme příklady katalogů užívajících rozhraní SPARQL endpoint.

Rozhraní DCAT-AP Dokumenty

Tato varianta rozhraní je určena pro instituce, které nechtějí nebo nemohou provozovat pro účely harvestace metadat o datových sadách do NKOD SPARQL endpoint. Počítá se serializací metadat o datových sadách do statických souborů umístěných na web podobně, jako varianta CKAN API, ale s využitím standardu DCAT-AP 2.0.1. Jako indexový soubor pak poslouží soubor obsahující instanci třídy dcat:Catalog, která pomocí vlastnosti dcat:dataset ukazuje na URL jednotlivých datových sad. Při přístupu na tato URL datových sad NKOD předpokládá, že v odpovědi dostane kompletní katalogizační záznam pro danou datovou sadu, včetně jejích distribucí a datových služeb.

Soubor katalogu

Soubor katalogu je soubor v RDF serializaci Turtle či JSON-LD, který obsahuje instanci třídy dcat:Catalog a odkazy na jednotlivé katalogizované datové sady.

Soubor datové sady

Na URL specifikovaných v souboru katalogu pak NKOD očekává soubory v RDF serializaci Turtle či JSON-LD obsahující kompletní metadatový záznam datové sady, včetně distribucí.

Rozhraní CKAN API

CKAN API je rozhraní nejrozšířenější implementace datového katalogu, CKAN. Je založené na formátu JSON [[!ECMA-404]], a obsahuje dvě hlavní funkce, package_list a package_show. Toto rozhraní je implemetováno samotným katalogem CKAN a také katalogem DKAN.

Rozhraní CKAN API je podporováno již jen v režimu zpětné kompatibility, což znamená, že se již nebude rozšiřovat o nové položky či funkcionality. Doporučujeme tedy použít jedno z ostatních rozhraní LKOD založených na standardu DCAT-AP 2.0.1.

Rozhraní CKAN API bylo pro NKOD rozšířeno o některé metadatové položky inspirované standardem DCAT-AP. Jsou k dispozici vzorová rozšíření pro CKAN a rozšíření pro DKAN, která lze využít pro předávání metadatových záznamů tímto rozhraním. Ani s tímto rozšířením ovšem nebude záznam úplný, jelikož se toto rozhraní nepřizpůsobuje standardu DCAT-AP 2.0.1.

Funkce package_list

Tato funkce vrací seznam identifikátorů jednotlivých datových sad registrovaných v LKOD. Tyto identifikátory se pak předávají funkci package_show v parametru id. Identifikátory mohou obsahovat písmena, čísla, pomlčky a podtržítka. Nesmí však obsahovat mezeru.

Funkce package_show

Tato funkce vrací metadatový záznam pro datovou sadu, jejíž identifikátor je předán v parametru id.

Datová sada

V této sekci jsou popsány položky týkající se datové sady ve funkci package_show.

Název datové sady
Vlastnost
title
Typ
Řetězec
Jméno
Název datové sady
Povinnost
Povinná
Příklad
Kontroly, Vystavené faktury
Popis datové sady
Vlastnost
notes
Typ
Řetězec
Jméno
Popis datové sady
Povinnost
Povinná
Příklad
Seznam kontrol od 1.1.2012
Periodicita aktualizace
Vlastnost
frequency
Typ
Řetězec dle EU slovníku pro frekvence.
Jméno
Periodicita aktualizace
Povinnost
Povinná
Příklad
ANNUAL, WEEKLY
Související geografické území - typ prvku RÚIAN
Vlastnost
ruian_type
Typ
Řetězec dle číselníku Typy prvků, územních prvků a územně evidenčních jednotek
Jméno
Související geografické území - typ prvku RÚIAN
Povinnost
Povinná
Příklad
ST, OB
Související geografické území - kód prvku RÚIAN
Vlastnost
ruian_code
Typ
Řetězec obsahující kód prvku RÚIAN
Jméno
Související geografické území - kód prvku RÚIAN
Povinnost
Povinná
Příklad
1, 502235
Klasifikace dle EuroVoc
Vlastnost
theme
Typ
Seznam IRI oddělený mezerou
Jméno
Klasifikace dle EuroVoc
Povinnost
Nepovinná
Příklad
http://eurovoc.europa.eu/171 http://eurovoc.europa.eu/695
E-mail Kurátora dat
Vlastnost
maintainer_email
Typ
E-mailová adresa
Jméno
E-mail Kurátora dat
Povinnost
Nepovinná
Příklad
verejnadata@instituce.cz
Jméno Kurátora dat
Vlastnost
maintainer
Typ
Řetězec
Jméno
Jméno Kurátora dat
Povinnost
Nepovinná
Příklad
Jan Novák
Odkaz na dokumentaci datové sady
Vlastnost
schema
Typ
URL webové stránky
Jméno
Odkaz na dokumentaci datové sady
Povinnost
Nepovinná
Příklad
https://www.INSTITUCE.cz/open-data/dokumentace-ds1.html
Klíčová slova
Vlastnost
tags
Typ
Pole objektů s vlastností name
Jméno
Klíčová slova
Povinnost
Povinná
Příklad
"tags": [
{"name": "kontroly"},
{"name": "sankce"}
]
Dotčené časové období od
Vlastnost
temporal_start
Typ
Datum
Jméno
Dotčené časové období od
Povinnost
Nepovinná
Příklad
2012-01-01
Dotčené časové období do
Vlastnost
temporal_end
Typ
Datum
Jméno
Dotčené časové období do
Povinnost
Nepovinná
Příklad
2014-12-31
Distribuce datové sady
Vlastnost
resources
Typ
Pole objektů, viz Distribuce
Jméno
Distribuce datové sady
Povinnost
Povinná

Distribuce datové sady

V této sekci jsou popsány položky týkající se distribuce datové sady ve funkci package_show.

Odkaz na stažení souboru
Vlastnost
url
Typ
URL
Jméno
Odkaz na stažení distribuce datové sady
Povinnost
Povinná
Příklad
https://www.INSTITUCE.cz/open-data/kontroly.trig
Media type souboru ke stažení
Vlastnost
format
Typ
Řetězec obsahující Media type dle IANA [[!IANA-MEDIA-TYPES]]
Jméno
Media type souboru ke stažení
Povinnost
Povinná
Příklad
application/trig
Název distribuce datové sady
Vlastnost
name
Typ
Řetězec
Jméno
Název distribuce datové sady
Povinnost
Nepovinná
Příklad
Kontroly v RDF TriG
Odkaz na strojově čitelné schéma souboru ke stažení
Vlastnost
describedBy
Typ
URL
Jméno
Odkaz na strojově čitelné schéma souboru ke stažení
Povinnost
Nepovinná
Příklad
https://www.INSTITUCE.cz/open-data/ontologie.trig

URL funkcí package_list a package_show

URL funkcí package_list a package_show musí splňovat pravidlo, které zajistí, že NKOD na základě URL package_list najde URL funkce package_show. Toto pravidlo je automaticky splněno při použití CKAN či DKAN. Pokud ale instituce CKAN API simuluje statickými soubory, je třeba se ujistit, že je stále dodrženo.

URL funkce package_show se z URL funkce package_list získá odstraněním části od posledního lomítka, a přidáním textu package_show?id= a id datové sady, které vrátila funkce package_list.

Příklady lokálních katalogů s CKAN API

V této sekci uvádíme příklady katalogů užívajících rozhraní CKAN API. Ne všechny katalogy ho ovšem používá správně. Závazné je použití dle této specifikace.