Datenobjekte

Der Collectu Hub bietet eine einfach zu bedienende JSON-Datenbank. Sie können JSON-basierte Daten speichern, versionieren und gemeinsam nutzen.

Info

JSON (JavaScript Object Notation) ist ein leichtgewichtiges Datenformat zum Speichern und Austauschen strukturierter Informationen, das von Menschen leicht gelesen und geschrieben und von Maschinen leicht analysiert und generiert werden kann. JSON stellt Daten mithilfe von Schlüssel-Wert-Paaren dar, ähnlich wie ein Dictionary in vielen Programmiersprachen. Es unterstützt Datentypen wie Zeichenketten, Zahlen, boolesche Werte, Listen und verschachtelte Objekte. Aufgrund seiner Einfachheit und Kompatibilität wird JSON häufig in Webanwendungen, APIs und zur Datenspeicherung verwendet.

{
  "name": "Collectu",
  "age": 5,
  "email": "info@collectu.de",
  "features": ["easy", "open"],
  "address": {
    "city": "Oberriexingen",
    "zip": "71739"
  }
}

Funktionsweise

Im Allgemeinen ist jedes Datenobjekt ein JSON-Datenobjekt in einem bestimmten Pfad auf der Collectu API. Der Pfad eines Datenobjekts muss eindeutig sein und mit dem Benutzernamen des Eigentümers beginnen, z. B. https://api.collectu.de/api/v1/data_object/user123/machines/cnc1.

Die Pfade von Datenobjekten können verwendet werden, um verschachtelte Datenobjekte zu erstellen. Ein Beispiel hierfür wäre:

  • user123/machines/cnc1
  • user123/machines/cnc2

Wenn wir die verschachtelten Daten (include_all = true) für den Pfad user123/machines abfragen, erhalten wir folgendes Ergebnis:

{
    "cnc1": {
        "name": "cnc1",
        "status": "stopped",
    },
    "cnc2": {
        "name": "cnc2",
        "status": "running"
    }
}

Features

Der Datenobjekt-Service des Collectu Hub bietet einige Hauptfunktionen, die im Folgenden erläutert werden.

Interne und externe Referenzen

Jedes Datenobjekt kann eine interne und/oder externe Referenz haben.

  • Interne Referenzen verknüpfen die Daten eines Datenobjekts mit einem anderen Datenobjekt.
  • Externe Referenzen verknüpfen Daten eines Datenobjekts mit einer externen REST-API. Der angegebene Endpunkt muss einen gültigen JSON zurückgeben.
Info
Die Reihenfolge der Extraktion ist: externe Referenz, interne Referenz, Daten des Datenobjekts, d.h. die Daten der externen Referenz werden mit den Daten der internen Referenz überschrieben, und beide Referenzen werden mit den Daten des Datenobjekts selbst überschrieben.

Schemas

Um das erwartete Datenobjekt zu beschreiben, können Sie JSON-Schemata verwenden. JSON Schema ist eine deklarative Sprache zur Kommentierung und Validierung der Struktur, Einschränkungen und Datentypen von JSON-Dokumenten.

Informationen über die Erstellung eines JSON-Schemas finden Sie hier: https://json-schema.org

Warnung
Die referenzierten Daten (intern und extern) werden nicht anhand des Schemas validiert.

Versionierung

Datenobjekte können versioniert werden, d.h. jedes Mal, wenn ein bestehendes Datenobjekt aktualisiert wird, wird eine neue Version erzeugt. Dies bedeutet, dass Änderungen immer nachvollzogen werden können.

Warnung
Verwenden Sie die Versionierung nicht, wenn ein Datenobjekt häufig aktualisiert wird!

Benutzung

Collectu bietet vordefinierte Module für die Abfrage (inputs.web.collectu_data_objects_1) und Veröffentlichung (outputs.web.collectu_data_objects_1) von Datenobjekten auf dem Collectu Hub.

REST API

Sie können unsere REST API verwenden, um mit unserem Datenobjekt-Service zu interagieren. Alle Endpunkte können hier gefunden und verwendet werden: https://api.collectu.de

Autorisierung

Wenn ein Datenobjekt nicht öffentlich (public) ist, kann darauf nur zugegriffen werden, wenn das richtige Token in der Anfrage angegeben wird. Fügen Sie dazu den folgenden Header ein:

{"Authorization": "Bearer your-api-access-token"}

Zurück
Grafana
Weiter
Hooks