forked from fraunhoferfokus/ogd-metadata
-
Notifications
You must be signed in to change notification settings - Fork 0
/
OGPD_JSON_Schema.html
executable file
·119 lines (110 loc) · 17.5 KB
/
OGPD_JSON_Schema.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<html><head>
<meta http-equiv=Content-Type content="text/html; charset=UTF-8">
<style type="text/css">
<!--
td {vertical-align:top;}
-->
</style>
</head><body>
<table border=1 cellpadding=0 cellspacing=0 style="empty-cells:show;vertical-align:top">
<col > <col span=3><col ><col ><col ><col >
<tr>
<th rowspan=2 >Metadaten Eintrag</th>
<th colspan=3 >JSON Bezeichner</th>
<th rowspan=2 >Pflichtfeld</th>
<th rowspan=2 >Datentyp</th>
<th rowspan=2 >Format / Pattern</th>
<th rowspan=2 >Beschreibung</th>
</tr>
<tr>
<th >1.
Ebene (CKAN nativ)</th>
<th >2. Ebene</th>
<th >3. Ebene</th>
</tr>
<tr><td rowspan="1">Name</td><td rowspan="1">name</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">X</td><td rowspan="1">String</td><td rowspan="1">^[a-z0-9_-]{2,}$</td><td rowspan="1">Ein für Menschen lesbarer Bezeichner des Datensatzes, des Dokuments oder der Apps, der für eine Identifizierung genutzt werden kann (einfache ASCII-Präsentation des Titels, auch für die Pretty-Link-URL, Linked Data URIs)</td></tr>
<tr><td rowspan="1">Titel</td><td rowspan="1">title</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">X</td><td rowspan="1">String</td><td rowspan="1"></td><td rowspan="1">Der Titel beschreibt den Datensatz, das Dokument oder die App prägnant und wird z. B. in Suchergebnissen und Listen angezeigt.</td></tr>
<tr><td rowspan="1">Beschreibung</td><td rowspan="1">notes</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">X</td><td rowspan="1">String</td><td rowspan="1"></td><td rowspan="1">Beschreibung und weitere Informationen zum Datensatz, zum Dokument oder zur App, wird auf der Detailseite dargestellt und kann mehrere Absätze umfassen.</td></tr>
<tr><td rowspan="1">Kategorien</td><td rowspan="1">groups</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">X</td><td rowspan="1">Liste von String</td><td rowspan="1">Enum aus: wirtschaft_arbeit, transport_verkehr, umwelt_klima, geo, gesundheit, verbraucher, infrastruktur_bauen_wohnen, bildung_wissenschaft, verwaltung, gesetze_justiz, bevoelkerung, politik_wahlen, soziales, kultur_freizeit_sport_tourismus</td><td rowspan="1">Kategorien für die Datensätze und Dokumente. Die Kategorien sind statisch und werden vom Portalbetreiber langfristig gepflegt, s.u. bzw. <a href='https://github.com/fraunhoferfokus/ogd-metadata/blob/master/kategorien/deutschland.json'>Liste</a></td></tr>
<tr><td rowspan="1">Schlagwörter</td><td rowspan="1">tags</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">Liste von String</td><td rowspan="1"></td><td rowspan="1">Freie Schlüsselwörter des Datensatzes, des Dokuments oder der App</td></tr>
<tr><td rowspan="1">Website</td><td rowspan="1">url</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">URI</td><td rowspan="1">Die ursprüngliche Webadresse des Datensatzes, Dokuments oder der App, um zu weiteren Informationen über den Datensatz, das Dokument oder die App zu gelangen. Wird auf der Detailseite als Link angezeigt.</td></tr>
<tr><td rowspan="1">Typ</td><td rowspan="1">type</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">X</td><td rowspan="1">String</td><td rowspan="1">Enum aus: datensatz, dokument, app</td><td rowspan="1">Zeigt an, ob ein Datensatz, ein Dokument, eine App beschrieben wird. Entscheidet darüber, in welchem Bereich diese Metadaten angezeigt werden.</td></tr>
<tr><td rowspan="1">Ressourcen</td><td rowspan="6">resources</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">X</td><td rowspan="1">Liste von Object</td><td rowspan="1"></td><td rowspan="1">Folgende Felder können für jede Ressource individuell angegeben werden.</td></tr>
<tr><td rowspan="1">URL</td><td rowspan="1">url</td><td rowspan="1"></td><td rowspan="1">X</td><td rowspan="1">String</td><td rowspan="1">URI</td><td rowspan="1">Verweis auf die eigentliche Datendatei, das Dokument oder die Anwendung.</td></tr>
<tr><td rowspan="1">Format</td><td rowspan="1">format</td><td rowspan="1"></td><td rowspan="1">X</td><td rowspan="1">String</td><td rowspan="1"></td><td rowspan="1">Typ der Ressource (MIME Types)</td></tr>
<tr><td rowspan="1">Beschreibung</td><td rowspan="1">description</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1"></td><td rowspan="1">Erläuterung, welche Rolle die Ressource für den Datensatz, das Dokument bzw. die App spielt (z. B. ob es sich dabei um eine bestimmte Zeitscheibe oder Schlüsselliste handelt. Der Beschreibungstext, wird mit dem Link zur Ressource unterlegt.)</td></tr>
<tr><td rowspan="1">Sprache</td><td rowspan="1">language</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">^[a-z]{2}$</td><td rowspan="1">Sprache als ISO 639-1-Code, in der die Ressource verfasst ist.</td></tr>
<tr><td rowspan="1">Prüfsumme</td><td rowspan="1">hash</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1"></td><td rowspan="1">Bei statischen Dateien die SHA2-Prüfsumme bzw. bei dynamischen Daten ein Zertifikat zur Überprüfung der Integrität.</td></tr>
<tr><td rowspan="1">Extras</td><td rowspan="31">extras</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">X</td><td rowspan="1">Object</td><td rowspan="1"></td><td rowspan="1">Zusaetzliche Angaben</td></tr>
<tr><td rowspan="1">Kontakte</td><td rowspan="6">contacts</td><td rowspan="1"></td><td rowspan="1">X</td><td rowspan="1">Liste von Object</td><td rowspan="1"></td><td rowspan="1">Liste der Kontakte zu Metadaten, Daten, Dokument bzw. App, mindestens ein Kontakt ist anzugeben, bevorzugt der Ansprechpartner.</td></tr>
<tr><td rowspan="1">Rolle</td><td rowspan="1">role</td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">Enum aus: veroeffentlichende_stelle, ansprechpartner, vertrieb, autor</td><td rowspan="1">Rolle, die dieser Kontakt für das Metadatum innehat. Unter Veröffentlichende Stelle wird die zuständige Behörde bzw. Organisationseinheit verstanden verstanden. Diese Angabe wird auch für den Filter 'nach Bereitsteller' genutzt. Der 'ansprechpartner' soll dagegen von den Datennutzern bei Fragen und Kommentaren kontaktiert werden, daher können auch Funktionstitel und Funktions-Emailadressen angegeben werden.</td></tr>
<tr><td rowspan="1">Name</td><td rowspan="1">name</td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1"></td><td rowspan="1">Name der Person oder Funktion</td></tr>
<tr><td rowspan="1">Website</td><td rowspan="1">url</td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">URI</td><td rowspan="1">Webseite des Kontakts</td></tr>
<tr><td rowspan="1">Email</td><td rowspan="1">email</td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1"></td><td rowspan="1">Email-Adresse des Kontakts, wird auch für Benachrichtigungen genutzt.</td></tr>
<tr><td rowspan="1">Adresse</td><td rowspan="1">address</td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1"></td><td rowspan="1">Postalische Adresse des Kontakts</td></tr>
<tr><td rowspan="1">Kalender-Daten</td><td rowspan="3">dates</td><td rowspan="1"></td><td rowspan="1">X</td><td rowspan="1">Liste von Object</td><td rowspan="1"></td><td rowspan="1">Erstellungs-, Veröffentlichungs- und Aktualisierungsdaten von Daten, Dokumenten, Apps und ihren Metadaten. Wird in der Oberfläche so angezeigt, dass Datennutzer einen Eindruck davon bekommen, wie aktuell die Daten sind.</td></tr>
<tr><td rowspan="1">Rolle</td><td rowspan="1">role</td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">Enum aus: erstellt, veroeffentlicht, aktualisiert</td><td rowspan="1">Rolle, die dieses Datum für den Datensatz spielt</td></tr>
<tr><td rowspan="1">Datum</td><td rowspan="1">date</td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">date-time</td><td rowspan="1">Das Kalender-Datum</td></tr>
<tr><td rowspan="1">Nutzungsbestimmungen</td><td rowspan="5">terms_of_use</td><td rowspan="1"></td><td rowspan="1">X</td><td rowspan="1">Object</td><td rowspan="1"></td><td rowspan="1">Festlegung der spezifischen Nutzungsbestimmungen des Datensatzes, des Dokuments oder der App.</td></tr>
<tr><td rowspan="1">Lizenz-ID</td><td rowspan="1">license_id</td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">Enum aus: apache, bsd-license, cc-by, cc-by-sa, cc-nc, cc-zero, gfdl, gpl-3.0, mit-license, mozilla, mozilla1.1, odc-odbl, other-closed, other-open, app_openSource, app_freeware, app_kommerziell</td><td rowspan="1">Lizenz aus einer festen Liste, s.u. bzw. <a href='https://github.com/fraunhoferfokus/ogd-metadata/blob/master/lizenzen/deutschland.json'>Liste</a></td></tr>
<tr><td rowspan="1">Freitext</td><td rowspan="1">other</td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1"></td><td rowspan="1">Freitext, der die Nutzungsbestimmungen festlegt, falls diese keiner allgemein bekannten Lizenz entsprechen.</td></tr>
<tr><td rowspan="1">URL</td><td rowspan="1">license_url</td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">URI</td><td rowspan="1">URL, auf der die Lizenz des Datensatzes, Dokuments oder der App beschrieben und erklärt ist.</td></tr>
<tr><td rowspan="1">Nutzungsfreiheit</td><td rowspan="1">is_free_to_use</td><td rowspan="1"></td><td rowspan="1">Boolean</td><td rowspan="1"></td><td rowspan="1">Die Information, ob der Datensatz/das Dokument/die App kostenfrei und zweckoffen ist (muss gesetzt werden, wenn Freitext bei der Lizenzangabe genutzt wird).</td></tr>
<tr><td rowspan="1">Unterkategorien</td><td rowspan="1">subgroups</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">Liste von String</td><td rowspan="1"></td><td rowspan="1">Unterkategorien für die Datensätze und Dokumente. Im Gegensatz zu den Kategorien werden hier genau die (fachlichen) Kategorien der Datenbereitsteller genutzt, d.h. jeder neu angeschlossene Datenbereitsteller kann hier benötigte Unterkategorien hinzufügen, beispielsweise aus INSPIRE oder EVAS. Vgl. <a href='https://github.com/fraunhoferfokus/ogd-metadata/blob/master/kategorien/'>Liste</a>. Unterkategorien werden auch für die Navigation und für Filter genutzt.</td></tr>
<tr><td rowspan="1">Original-Metadaten-Portal</td><td rowspan="1">metadata_original_portal</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">URI</td><td rowspan="1">URL des Portals, von dem der Metadateneintrag des Datensatzes oder des Dokuments geharvestet wurde.</td></tr>
<tr><td rowspan="1">Original-Metadaten-Schlüssel</td><td rowspan="1">metadata_original_id</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1"></td><td rowspan="1">Der Identifier des ursprünglichen Metadateneintrags der Datensätze oder der Dokumente. Damit kann schnell die Originalposition von geharvesteten Datensätzen oder Dokumenten nachvollzogen und Dubletten erkannt werden. Wird nicht in der Oberfläche angezeigt.</td></tr>
<tr><td rowspan="1">Original-Metadaten-XML</td><td rowspan="1">metadata_original_xml</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">URI</td><td rowspan="1">URL des Original-Metadateneintrags in der urspruenglichen Form. Wird nicht in der Oberfläche angezeigt. Erscheint als Link in der Detailseite.</td></tr>
<tr><td rowspan="1">Original-Metadaten-HTML</td><td rowspan="1">metadata_original_html</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">URI</td><td rowspan="1">URL des Original-Metadateneintrags in der HTML-Represantationsform. Erscheint als Link in der Detailseite.</td></tr>
<tr><td rowspan="1">Abdeckung in Koordinaten</td><td rowspan="3">spatial</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">Object</td><td rowspan="1"></td><td rowspan="1">Die geographische Abdeckung des Datensatzes in WGS 84 Koordinaten nach GeoJSON http:https://geojson.org . Wird später für eine geographische Suche verwendet.</td></tr>
<tr><td rowspan="1">Art der Form</td><td rowspan="1">type</td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">Enum aus: polygon</td><td rowspan="1">Hier ist zunächst nur Polygon vorgesehen, andere waeren vorstellbar.</td></tr>
<tr><td rowspan="1">Koordinaten Liste der Koordinaten</td><td rowspan="1">coordinates</td><td rowspan="1"></td><td rowspan="1">Liste von Array</td><td rowspan="1"></td><td rowspan="1">Koordinaten Liste der Koordinaten</td></tr>
<tr><td rowspan="1">Abdeckung als Text</td><td rowspan="1">spatial-text</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1"></td><td rowspan="1">Abgedecktes Gebiets, wenn möglich der Amtliche Gemeindeschlüssel. Wird später für eine geographische Suche verwendet.</td></tr>
<tr><td rowspan="1">Räumliche Auflösung</td><td rowspan="1">geographical_granularity</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">Enum aus: bund, land, kommune, stadt</td><td rowspan="1">Die geographische Granularität des Datensatzes, eines Dokuments, einer App. Wird später zum Filtern verwendet.</td></tr>
<tr><td rowspan="1">Start-Datum</td><td rowspan="1">temporal_coverage_from</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">date-time</td><td rowspan="1">Der Zeitpunkt, von dem an der Datensatz, das Dokument oder die App einschließlich Daten enthält. Wird insb. zum Filtern verwendet.</td></tr>
<tr><td rowspan="1">End-Datum</td><td rowspan="1">temporal_coverage_to</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">date-time</td><td rowspan="1">Der Zeitpunkt, bis zu dem der Datensatz, das Dokument oder die App einschließlich Daten enthält. Wird insb. zum Filtern verwendet.</td></tr>
<tr><td rowspan="1">Zeitliche Auflösung</td><td rowspan="1">temporal_granularity</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">Enum aus: sekunde, minute, stunde, tag, woche, monat, quartal, jahr, 5-jahre</td><td rowspan="1">Die zeitliche Auflösung der enthaltenen Daten, des Dokuments oder der App. Wird später zum Filtern verwendet.</td></tr>
<tr><td rowspan="1">Verwendete Datensätze</td><td rowspan="1">used_datasets</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">Liste von String</td><td rowspan="1">URI</td><td rowspan="1">Die verwendeten Datensätze von Apps mithilfe einer Liste mit URLs auf Metadaten. Wird auf der Detailseite von Apps angezeigt und ausgewertet um festzustellen, ob die App Open Data verwendet.</td></tr>
<tr><td rowspan="1">Sektor</td><td rowspan="1">sector</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">Enum aus: oeffentlich, privat, andere</td><td rowspan="1">Zeigt an, ob eine App oder ein Dokument aus dem öffentlichem, dem privaten oder einem anderen Bereich kommt. Wird in einen Piktogramm auf der Detailseite zum Ausdruck gebracht.</td></tr>
<tr><td rowspan="1">Struktur-Version</td><td rowspan="1">ogd_version</td><td rowspan="1"></td><td rowspan="1"></td><td rowspan="1">String</td><td rowspan="1">Enum aus: v1.0</td><td rowspan="1">Zeigt an, in welcher Version der OGD Metadaten-Struktur das Metadatum geschrieben ist. Wird nur intern verwendet, um nach Änderungen dieser Struktur festzustellen, ob die Metadaten schon angepasst wurden.</td></tr>
</table></body></html>
<p><table border=1 cellpadding=0 cellspacing=0
style='border-collapse:collapse;table-layout:fixed'>
<col>
<tr><th colspan='2'>Kategorien</th></tr>
<tr><th>ID</th><th>Titel</th></tr>
<tr><td>bevoelkerung</td><td>Bevölkerung</td></tr>
<tr><td>bildung_wissenschaft</td><td>Bildung und Wissenschaft</td></tr>
<tr><td>geo</td><td>Geographie, Geologie und Geobasisdaten</td></tr>
<tr><td>gesetze_justiz</td><td>Gesetze und Justiz</td></tr>
<tr><td>gesundheit</td><td>Gesundheit</td></tr>
<tr><td>infrastruktur_bauen_wohnen</td><td>Infrastruktur, Bauen und Wohnen</td></tr>
<tr><td>kultur_freizeit_sport_tourismus</td><td>Kultur, Freizeit, Sport und Tourismus</td></tr>
<tr><td>politik_wahlen</td><td>Politik und Wahlen</td></tr>
<tr><td>soziales</td><td>Soziales</td></tr>
<tr><td>transport_verkehr</td><td>Transport und Verkehr</td></tr>
<tr><td>umwelt_klima</td><td>Umwelt und Klima</td></tr>
<tr><td>verbraucher</td><td>Verbraucherschutz</td></tr>
<tr><td>verwaltung</td><td>Öffentliche Verwaltung, Haushalt und Steuern</td></tr>
<tr><td>wirtschaft_arbeit</td><td>Wirtschaft und Arbeit</td></tr>
</table>
<p><table border=1 cellpadding=0 cellspacing=0
style='border-collapse:collapse;table-layout:fixed'>
<col>
<tr><th colspan='2'>Lizenzen</th></tr>
<tr><th>ID</th><th>Titel</th></tr>
<tr><td>apache</td><td>Apache Software License</td></tr>
<tr><td>app_commercial</td><td>Andere kommerzielle Lizenz (nur für Anwendungen)</td></tr>
<tr><td>app_freeware</td><td>Andere kostenfreie Lizenz (nur für Anwendungen)</td></tr>
<tr><td>app_opensource</td><td>Andere Open Source Lizenz (nur für Anwendungen)</td></tr>
<tr><td>bsd-license</td><td>New and Simplified BSD Licenses</td></tr>
<tr><td>cc-by</td><td>Creative Commons Namensnennung</td></tr>
<tr><td>cc-by-sa</td><td>Creative Commons Weitergabe unter gleichen Bedingungen</td></tr>
<tr><td>cc-nc</td><td>Creative Commons Nicht-Kommerziell (eingeschränkte Lizenz)</td></tr>
<tr><td>cc-zero</td><td>Creative Commons Zero</td></tr>
<tr><td>gfdl</td><td>GNU Free Documentation License</td></tr>
<tr><td>gpl-3.0</td><td>GNU General Public License version 3.0 (GPLv3)</td></tr>
<tr><td>mozilla</td><td>Mozilla Public License 1.0 (MPL)</td></tr>
<tr><td>odc-odbl</td><td>Open Data Commons Open Database License</td></tr>
<tr><td>other-closed</td><td>Andere eingeschränkte Lizenz</td></tr>
<tr><td>other-open</td><td>Andere freie Lizenz</td></tr>
</table>