IoT Export
Verbindungs Template

Generic REST Server

10min

Einleitung

Das Export Modul "Generic REST Server" stellt einen REST Service per HTTP sowie HTTPS unter Verwendung des Generic IoT Datenmodell bereit.

Es handelt sich hierbei um ein "Single Service" Modul, somit kann nur eine Exportinstanz angelegt werden.

Konfiguration

Das Modul kann über den Bereich "IoT Export" in der Webkonfiguration oder der BSC Remote aktiviert und der "x-api-key" hinterlegt werden.

Zugriff

Der Service wird unter folgender URL bereitgestellt:

https://<IP des Gerätes>/iot/export/generic/things

Api Schutz

Bei der Aktivierung des Moduls kann ein "x-api-key" konfiguriert werden. Dieser ist standardmäßig mit einem zufälligen String befüllt.

Wird ein leerer String hinterlegt ist der Zugriff nicht geschützt.

Ansonsten muss der dort hinterlegte Key bei jeder Anfrage im Headerfeld "x-api-key" mitgesendet werden.

Endpunkte

Einstiegspunkt ist der /things Endpunkt. Dort werden alle Geräte mit detailierten Informationen aufgelistet.

Die weiteren Endpunkte dienen dazu, gezielt bestimmte Informationen eines Gerätes auszulesen oder auch eine Wertänderung vorzunehmen.

Geräte

Abrufen einer Liste aller verfügbaren Geräte Objekte
GET
Request
Header Parameters
x-api-key
optional
String
The optional X-Api-Key




Abrufen eines einzelnen Geräte Objektes anhand seiner ID.
GET
Request
Path Params
thingId
required
String
Die ID des Gerätes




Abrufen des aktuellen Verbindungsstatus anhand einer Geräte ID
GET
Request
Path Params
thingId
required
String
Die ID des Gerätes




Abrufen der Meta Informationen eines Gerätes anhand seiner ID
GET
Request
Path Params
thingId
required
String
Die ID des Gerätes


Kanäle

Abrufen des Kanalobjektes anhand der Geräte und Kanal ID
GET
Request
Path Params
thingId
required
String
Die ID des Gerätes
channelId
required
String
Die ID eines Gerätekanals




Abrufen des aktuellen Kanal Wertes anhand der Geräte und Kanal ID
GET
Request
Path Params
thingId
required
String
Die ID des Gerätes
channelId
required
String
Die ID eines Geräte Kanals




Setzt den Wert des über die Geräte und Kanal ID angegebenen Kanals
POST
Request
Path Params
thingId
required
String
Die ID des Gerätes
channelId
required
String
Die ID eines Geräte Kanals
Body Parameters
newValue
required
String
Der neue Wert


Der neue Wert wird als (raw) String direkt (ohne JSON Formatierung) in den Body der Anfrage geschrieben!



Abrufen der Meta Informationen eines Kanals anhand der Geräte und Kanal ID
GET
Request
Path Params
thingId
required
String
Die ID des Gerätes
channelId
required
String
Die ID eines Geräte Kanals




Abrufen der Wertebeschreibung eines Kanals anhand der Geräte und Kanal ID
GET
Request
Path Params
thingId
required
String
Die ID des Gerätes
channelId
required
String
Die ID eines Geräte Kanals




Abrufen der Kanalbeschreibung anhand der Geräte und Kanal ID
GET
Request
Path Params
thingId
required
String
Die ID des Gerätes
channelId
required
String
Die ID eines Geräte Kanals




Abfragen ob der Wert eines Kanals geändert werden kann
GET
Request
Path Params
thingId
required
String
Die ID des Gerätes
channelId
required
String
Die ID eines Geräte Kanals




Aktualisiert 25 Mar 2024
Doc contributor
Doc contributor
Hat Ihnen diese Seite geholfen?
VORHERIGE
Azure IoT Core Client
ALS NÄCHSTES
Generic Web Export
Docs powered by Archbee