Data API

The first 100 data points of this resource (sorted by insertion order, oldest first).

If many data points are queried, this can be done in individual steps using pagination.
Example: 100 data points after the first 500 of this resource (sorted by insertion order, oldest first).

A SQL condition can be specified to filter the data points.
Example: All data points of this resource that contain the string "42" in the "answer" field, sorted according to the "planet" field.

Beispiel: Alle Datenpunkte dieser Ressource, absteigend sortiert nach dem Feld "timestamp".

Mit einem WebSocket kann man über einen WebSocket-Client kontinuierlich über neue Daten in einer Ressource informiert werden. Sobald ein neuer Datenpunkt zu der Ressource hinzukommt, wird er über den WebSocket verschickt. Zur Benutzung des WebSockets reicht es, sich zur entsprechenden WebSocket-URL der Ressource in einem passenden WebSocket-Client zu verbinden.

Beispiel zur Benutzung des WebSocket mit JavaScript

const WebSocket = require('ws');

const ws = new WebSocket(
  wss://datenhub.ulm.de/api/v1/stream/kluga-klimawandelanpassung-in-ulm-durch-sensorgestutzte-internet-of-things-iot-anwendungen/bodenfeuchtesensor-mit-2-sonden, {
    rejectUnauthorized: false
});

ws.on('message', function incoming(data) {
  console.log(data);
});
                  

Mit einem Webhook kann ein externes System aufgerufen werden, sobald ein neuer Datenpunkt zu der Ressource hinzukommt. Dieser Aufruf enthält immer nur diesen neuen Datenpunkt. Werden mehrere gleichzeitig zur Ressource hinzugefügt, so wird das Zielsystem mehrfach hintereinander mit den einzelnen Datenpunkten aufgerufen.

Zur Erstellung eines Webhooks muss man angemeldet sein. Jede:r Nutzer:in kann nur einen Webhook pro Ressource erstellen. Beim Testen des Webhooks wird ein Datenpunkt der Ressource an das Zielsystem geschickt.

Bei Auftreten von Fehlern beim Aufruf des externen Systems, versucht die Datenplattform mindestens neun weitere Datenpunkte für mindestens eine Stunde zuzustellen. Können diese Datenpunkte hintereinander ebenfalls nicht zugestellt werden, wird das Abonnement automatisch pausiert.

Webhook erstellen

The following queries are only possible with write authorization:

Add new data points to this resource

The data points are transferred in JSON format. Please refer to Platform API documentation for more details.

Add new data points to this resource or overwrite existing data points

Existing data points will be overwritten if they have the same ID. Please refer to Platform API documentation for more details.

The following queries are only possible with write authorization:

Add new data points to this resource or overwrite existing data points

When creating a new resource, the first data point defines the schema of the resource. Please refer to Platform API documentation for more details.
Example: A new resource with the name "antares" is created.

The Data API can be accessed via the following actions of the CKAN action API.

https://datenhub.ulm.de/ckan/en/api/3/action/datastore_search?resource_id=ee5b5161-2499-46db-9c30-4e74a2434ef0&limit=5

https://datenhub.ulm.de/ckan/en/api/3/action/datastore_search?q=jones&resource_id=ee5b5161-2499-46db-9c30-4e74a2434ef0

https://datenhub.ulm.de/ckan/en/api/3/action/datastore_search_sql?sql=SELECT * from "ee5b5161-2499-46db-9c30-4e74a2434ef0" WHERE title LIKE 'jones'

https://datenhub.ulm.de/ckan/en/api/3/action/datastore_search_sql?sql=SELECT * from "ee5b5161-2499-46db-9c30-4e74a2434ef0" WHERE title LIKE 'jones' ORDER BY timestamp DESC

A simple ajax (JSONP) request to the data API using jQuery.

        var data = {
          resource_id: 'ee5b5161-2499-46db-9c30-4e74a2434ef0', // the resource id
          limit: 5, // get 5 results
          q: 'jones' // query for 'jones'
        };
        $.ajax({
          url: 'https://datenhub.ulm.de/ckan/en/api/3/action/datastore_search',
          data: data,
          dataType: 'jsonp',
          success: function(data) {
            alert('Total results found: ' + data.result.total)
          }
        });

      import urllib
      url = 'https://datenhub.ulm.de/ckan/en/api/3/action/datastore_search?resource_id=ee5b5161-2499-46db-9c30-4e74a2434ef0&limit=5&q=title:jones'  
      fileobj = urllib.urlopen(url)
      print fileobj.read()