DKAN API Anleitung

Über das Portal ist es nicht nur möglich Datensätze anzuschauen und herunterzuladen. Man kann ausgewählte Datensätze auch direkt über die URL ansteuern und so mit diesen arbeiten. Dies funktioniert über eine API (Programmierschnittstelle), die lesenden Zugriff auf Portalinhalte ermöglicht. Im Folgenden wird die Nutzung der API demonstriert. Die vollständige Dokumentation der DKAN-API ist unter http://docs.getdkan.com/en/latest/apis/index.html zu finden.

Dataset API

Diese API bezieht sich auf das Portal und dessen Inhalte im Allgemeinen. So ist es möglich, den Zustand des Portals auszulesen bis hin zu einer Ausgabe aller vorhandenen Datensätze. Die Ausgabe erfolgt immer im json Format.

Funktion site_read

Zeigt an, ob das Portal grundsätzlich erreichbar ist
Aufruf: http://opendata.oldenburg.de/api/3/action/site_read

Funktion package_list

Liefert eine Liste mit allen Datensatz Containern (Dataset)
Aufruf: http://opendata.oldenburg.de/api/3/action/package_list

Funktion current_package_list_with_ressources

Liefert eine Liste mit allen Datensatz Containern (Dataset) und den beinhaltenden Dateien (Ressourcen)
Aufruf: http://opendata.oldenburg.de/api/3/action/current_package_list_with_resources

Funktion package_show

Liefert die Metadaten eines Datensatzes und dessen Ressourcen
Parameter: id (eines Datensatzes)
Beispielaufruf: http://opendata.oldenburg.de/api/3/action/package_show?id=74208e4b-443b-4a9d-bfcb-6ecd1cfddc57

Funktion resource_show

Liefert die Metadaten einer Ressource
Parameter: id (einer Ressource)
Beispielaufruf: http://opendata.oldenburg.de/api/3/action/resource_show?id=c2fd8933-05aa-49e6-9561-5bd2ea1d58a9

Funktion group_list

Liefert die Namen der angelegten Gruppen (Datenbereitsteller)
Beispielaufruf: http://opendata.oldenburg.de/api/3/action/group_list

Datastore API

Diese API bezieht sich auf Datensätze, die von uns in den internen Datastore geladen wurden. Der Datastore bietet die Möglichkeit, (zurzeit nur CSV) Dateien in einem json Format aufrufbar zu machen. Dies ermöglicht das direkte arbeiten mit den einzelnen Ressourcen, ohne diese herunterladen zu müssen. Die einzelnen Dateien können nach folgendem Schema aufgerufen werden http://opendata.oldenburg.de/api/action/datastore/search.json?resource_id={ID der Ressource}. Zurzeit werden Ressourcen, bei denen ein Datastore Zugriff möglich ist, über den Button "Data API" innerhalb der Ressourcenansicht angezeigt. Hier wird auch ein Beispiel-Link mit der jeweiligen Ressourcen ID dargestellt. Folgende Beispiele beziehen sich auf die Ressource „1013 Schleuse Oldenburg_2.csv“ des Datensatzes Schleuse Oldenburg seit 1987 https://opendata.oldenburg.de/dataset/schleuse-oldenburg-seit-1987/resource/c2fd8933-05aa-49e6-9561-5bd2ea1d58a9

Parameter: limit

Beschränkt die Ausgabe auf die angegebene Anzahl der Treffer. Standardmäßig werden 100 Treffer zurückgegeben. Bei größeren Dateien wird empfohlen, eine Ausgabe von 100 Treffern nicht zu überschreiten, sondern bei Bedarf an weiteren Treffern den Parameter offset zu benutzen.
Beispielaufruf: https://opendata.oldenburg.de/api/action/datastore/search.json?resource_id=c2fd8933-05aa-49e6-9561-5bd2ea1d58a9&limit=5

Parameter: sort

Rückgabe der Daten in auf- [asc] oder absteigender [desc] Sortierung, entsprechend der gewählten Sortier-Eigenschaft d.h. Field nach dem sortiert werden soll.
Beispielaufruf: http://opendata.oldenburg.de/api/action/datastore/search.json?resource_id=c2fd8933-05aa-49e6-9561-5bd2ea1d58a9&sort[ladung_in_tonnen]=desc

Hinweis: alle Parameter sind untereinander kombinierbar.

Die vollständige Dokumentation über die DKAN-API ist unter http://docs.getdkan.com/en/latest/apis/index.html zu finden.

DKAN API HowTo