RAD Server EdgeModules
Nach oben zu RAD Server Administrative API
In der EMS-Datenbank werden Daten über die registrierten EMS-EdgeModules auf dem EMS-Server gespeichert. Mit der registrierten EdgeModules-Ressource können Sie auf diese Informationen zugreifen.
Mit der EMS-EdgeModules-Ressource können Sie ein EMS-EdgeModule und dessen Ressourcen auf Ihrem EMS-Server registrieren, entfernen oder ändern.
- Hinweis: Mit der TEMSClientAPI-Komponente registrieren, entfernen, aktualisieren oder rufen Sie die Dateninfo eines EMS-EdgeModules vom EMS-Server ab.
Inhaltsverzeichnis
- 1 Endpunkte der EdgeModules-Ressource
- 2 GetModules-Endpunkt
- 3 GetModule-Endpunkt
- 4 GetModulesFields-Endpunkt
- 5 GetResources-Endpunkt
- 6 GetModuleResources-Endpunkt
- 7 GetResourcesFields-Endpunkt
- 8 GetModuleResource-Endpunkt
- 9 RegisterModule-Endpunkt
- 10 RegisterModuleResource-Endpunkt
- 11 UpdateModule-Endpunkt
- 12 UpdateModuleResource-Endpunkt
- 13 UnregisterModule-Endpunkt
- 14 UnregisterModuleResource-Endpunkt
- 15 GetResourceEndpoint-Endpunkt
- 16 GetResourceEndpointItem-Endpunkt
- 17 PutResourceEndpoint-Endpunkt
- 18 PutResourceEndpointItem-Endpunkt
- 19 PostResourceEndpoint-Endpunkt
- 20 PostResourceEndpointItem-Endpunkt
- 21 PatchResourceEndpoint-Endpunkt
- 22 PatchResourceEndpointItem-Endpunkt
- 23 DeleteResourceEndpoint-Endpunkt
- 24 DeleteResourceEndpointItem-Endpunkt
- 25 EMS-EdgeModules-Felder
- 26 Siehe auch
Endpunkte der EdgeModules-Ressource
EdgeModules-Ressource stellt die folgenden Endpunkte einer EMS-Ressource bereit:
Name der Endpunktmethode | Ressourcensuffix | HTTP-Anforderungstyp | Verwendung |
---|---|---|---|
GetModules |
-- |
HTTP GET |
Zum Abrufen aller Daten aus der EdgeModules-Ressource. |
GetModule |
|
HTTP GET |
Zum Abrufen aller Daten aus einem EdgeModule. |
GetModulesFields |
|
HTTP GET |
Zum Abrufen der Feldnamen aller EMS-EdgeModules. |
GetResources |
|
HTTP GET |
Zum Abrufen aller Daten aus den Ressourcen aller EdgeModules. |
GetModuleResources |
|
HTTP GET |
Zum Abrufen aller Daten aus den Ressourcen eines EdgeModule. |
GetResourcesFields |
|
HTTP GET |
Zum Abrufen der Feldnamen aller Ressourcen der EMS-EdgeModules. |
GetModuleResource |
|
HTTP GET |
Zum Abrufen aller Daten aus einer Ressource eines EdgeModule. |
RegisterModule |
-- |
HTTP POST |
Zum Hinzufügen eines neuen EMS-EdgeModule zur EMS-Datenbank. |
RegisterModuleResource |
|
HTTP POST |
Zum Registrieren einer neuen Ressource eines EdgeModule. |
UpdateModule |
|
HTTP PUT |
Zum Aktualisieren der Daten eines bestehenden EMS-EdgeModule. |
UpdateModuleResource |
|
HTTP PUT |
Zum Aktualisieren aller Daten einer bestehenden Ressource eines EMS-EdgeModule. |
UnregisterModule |
|
HTTP DELETE |
Zum Löschen eines bestehenden EMS-EdgeModule. |
UnregisterModuleResource |
|
HTTP DELETE |
Zum Löschen der Daten einer bestehenden Ressource aus einem EMS-EdgeModule. |
GetResourceEndpoint |
|
HTTP GET |
Zum Abrufen der Daten vom |
GetResourceEndpointItem |
|
HTTP GET |
Zum Abrufen der Daten eines bestimmten Endpunkts aus einer EMS-EdgeModule-Ressource. |
PutResourceEndpoint |
|
HTTP PUT |
Zum Aktualisieren der Daten eines Ressourcenendpunkts eines bestehenden EMS-EdgeModule. |
PutResourceEndpointItem |
|
HTTP PUT |
Zum Aktualisieren der Daten eines bestimmten Endpunkts einer EMS-EdgeModule-Ressource. |
PostResourceEndpoint |
|
HTTP POST |
Zum Hinzufügen neuer Daten zum Ressourcenendpunkt eines bestehenden EMS EdgeModule. |
PostResourceEndpointItem |
|
HTTP POST |
Zum Hinzufügen neuer Daten eines angegebenen Endpunkts einer EMS-EdgeModule-Ressource. |
PatchResourceEndpoint |
|
HTTP PATCH |
Zur Anforderung einer Gruppe von Änderungen an den Daten des Ressourcenendpunkts eines bestehenden EMS-EdgeModule. |
PatchResourceEndpointItem |
|
HTTP PATCH |
Zur Anforderung einer Gruppe von Änderungen an den Daten eines bestimmten Endpunkts einer EMS-EdgeModule-Ressource. |
DeleteResourceEndpoint |
|
HTTP DELETE |
Zum Löschen der Daten des Ressourcenendpunkts eines bestehenden EMS EdgeModule. |
DeleteResourceEndpointItem |
|
HTTP DELETE |
Zum Löschen der Daten eines angegebenen Endpunkts einer EMS-EdgeModule-Ressource. |
GetModules-Endpunkt
Gibt eine Liste der EMS-EdgeModules-Daten zurück.
Verwenden Sie die QueryModules-Methode oder die TBackendQuery-Komponenten und die EdgeModule-Ressource, um die Liste der EMS-EdgeModule abzurufen.
Bei Erfolg enthält die Antwort vom EMS-Server eine Liste aller EMS-EdgeModules mit den jeweiligen Details
- modulename
- _id
- protocol
- protocolprops (Port und Host)
- _meta (Felder "creator", "created date" und "updated date")
- Benutzerdefinierte Felder (optional)
Beispielantwort
So könnte eine Antwort vom Server aussehen:
[
{
"modulename": "WinEdge1",
"_id": "34C977F1-4DCE-4412-ACE8-35339CEE7282",
"protocol": "http",
"protocolprops": "{\"port\":8082,\"host\":\"localhost\"}",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000000",
"created": "2015-08-12T14:57:19.000Z"
}
},
{
"modulename": "WinEdge2",
"_id": "5B2A78B8-2599-433F-956D-720A12FFCD0B",
"protocol": "http",
"protocolprops": "{\"port\":8081,\"host\":\"localhost\"}",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000000",
"created": "2015-08-13T13:54:18.000Z"
}
}
]
GetModule-Endpunkt
Gibt die Daten eines angegebenen EMS-EdgeModule zurück.
Ihre Anforderung muss das folgende Feld enthalten:
- _id
Verwenden Sie die RetrieveModule-Methode oder die TBackendQuery-Komponente und die EdgeModule-Ressource, um deren Daten abzurufen.
Bei Erfolg enthält die Antwort vom EMS-Server das EMS-EdgeModule mit den folgenden Einzelheiten:
- modulename
- _id
- protocol
- protocolprops (Port und Host)
- _meta (Felder "creator", "created date" und "updated date")
- Benutzerdefinierte Felder (optional)
Beispielantwort
Dies ist eine Beispielantwort für das Modul "5B2A78B8-2599-433F-956D-720A12FFCD0B":
{
"modulename": "WinEdge2",
"_id": "5B2A78B8-2599-433F-956D-720A12FFCD0B",
"protocol": "http",
"protocolprops": "{\"port\":8081,\"host\":\"localhost\"}",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000000",
"created": "2015-08-13T13:54:18.000Z"
}
}
GetModulesFields-Endpunkt
Ruft die Feldnamen aller EMS-EdgeModules aus der EMS-Datenbank ab.
Mit der Methode RetrieveModulesFields rufen Sie die Felder eines EMS-EdgeModule ab.
Bei Erfolg enthält die Antwort vom EMS-Server alle Feldnamen der EMS-EdgeModules.
- modulename
- _id
- protocol
- protocolprops
- _meta (Felder "creator", "created" und "updated")
Beispielantwort
So könnte eine Antwort vom Server aussehen:
[
{
"name": "modulename"
},
{
"name": "_id"
},
{
"name": "protocol"
},
{
"name": "protocolprops"
},
{
"name": "_meta",
"fields": [
{
"name": "creator"
},
{
"name": "created"
},
{
"name": "updated"
}
]
}
]
GetResources-Endpunkt
Gibt eine Liste der Ressourcen aller EMS-EdgeModules zurück.
Verwenden Sie die QueryModuleResources-Methode oder die TBackendQuery-Komponente und die EdgeModule-Ressource, um die Liste der Ressourcen von den EMS-EdgeModules abzurufen.
Bei Erfolg enthält die Antwort vom EMS-Server eine Liste von Ressourcen aller EMS-EdgeModules mit den jeweiligen Einzelheiten.
- resourcename
- modulename
- moduleid
- _meta (Felder "creator", "created date" und "updated date")
- Benutzerdefinierte Felder (optional)
Beispielantwort
So könnte eine Antwort vom Server aussehen:
[
{
"resourcename": "version",
"modulename": "WinEdge1",
"moduleid": "34C977F1-4DCE-4412-ACE8-35339CEE7282",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000000",
"created": "2015-08-12T14:57:19.000Z"
}
},
{
"resourcename": "Measurements",
"modulename": "WinEdge1",
"moduleid": "34C977F1-4DCE-4412-ACE8-35339CEE7282",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000000",
"created": "2015-08-12T14:57:19.000Z"
}
},
{
"resourcename": "version",
"modulename": "WinEdge2",
"moduleid": "5B2A78B8-2599-433F-956D-720A12FFCD0B",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000000",
"created": "2015-08-13T13:54:18.000Z"
}
},
{
"resourcename": "Measurements",
"modulename": "WinEdge2",
"moduleid": "5B2A78B8-2599-433F-956D-720A12FFCD0B",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000000",
"created": "2015-08-13T13:54:18.000Z"
}
}
]
GetModuleResources-Endpunkt
Gibt eine Liste der Ressourcendaten für ein angegebenes EMS-EdgeModule zurück.
Verwenden Sie die QueryModuleResources-Methode oder die TBackendQuery-Komponente und die EdgeModule-Ressource, um die Liste der Ressourcen aus einem EMS-EdgeModule abzurufen.
Bei Erfolg enthält die Antwort vom EMS-Server eine Liste aller Ressourcen eines EMS-EdgeModule mit jeweiligen Einzelheiten.
- resourcename
- modulename
- moduleid
- _meta (Felder "creator", "created date" und "updated date")
- Benutzerdefinierte Felder (optional)
Beispielantwort
Dies ist eine Beispielantwort für das Modul "5B2A78B8-2599-433F-956D-720A12FFCD0B":
[
{
"resourcename": "version",
"modulename": "WinEdge2",
"moduleid": "5B2A78B8-2599-433F-956D-720A12FFCD0B",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000000",
"created": "2015-08-13T13:54:18.000Z"
}
},
{
"resourcename": "Measurements",
"modulename": "WinEdge2",
"moduleid": "5B2A78B8-2599-433F-956D-720A12FFCD0B",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000000",
"created": "2015-08-13T13:54:18.000Z"
}
}
]
GetResourcesFields-Endpunkt
Ruft die Feldnamen aller Ressourcen aller EMS-EdgeModules aus der EMS-Datenbank ab.
Mit der Methode RetrieveModuleResourcesFields rufen Sie die Felder der Ressourcen aus den EMS-EdgeModules ab.
Bei Erfolg enthält die Antwort vom EMS-Server alle Feldnamen der Ressourcen aus den EMS-EdgeModules.
- resourcename
- modulename
- moduleid
- _meta (Felder "creator", "created" und "updated")
- users
Beispielantwort
So könnte eine Antwort vom Server aussehen:
[
{
"name": "resourcename"
},
{
"name": "modulename"
},
{
"name": "moduleid"
},
{
"name": "_meta",
"fields": [
{
"name": "creator"
},
{
"name": "created"
},
{
"name": "updated"
}
]
}
]
GetModuleResource-Endpunkt
Gibt die Daten einer angegebenen Ressource für ein EMS-EdgeModule zurück.
Verwenden Sie die RetrieveModuleResource-Methode oder die TBackendQuery-Komponente und die EdgeModule-Ressource, um die Daten einer Ressource aus einem EMS-EdgeModule abzurufen.
Bei Erfolg enthält die Antwort vom EMS-Server alle Daten von Ressourcen eines EMS-EdgeModule mit den jeweiligen Einzelheiten.
- resourcename
- modulename
- moduleid
- _meta (Felder "creator", "created date" und "updated date")
- Benutzerdefinierte Felder (optional)
Beispielantwort
Dies ist eine Beispielantwort für das Modul "5B2A78B8-2599-433F-956D-720A12FFCD0B" und die Ressource "version":
{
"resourcename": "version",
"modulename": "WinEdge2",
"moduleid": "5B2A78B8-2599-433F-956D-720A12FFCD0B",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000000",
"created": "2015-08-13T13:54:18.000Z"
}
}
RegisterModule-Endpunkt
Registriert das angegebene EMS-EdgeModule beim EMS-Server.
Ihre Anforderung muss die folgenden Felder enthalten:
- modulename
- protocol
- protocolprops (Port und Host)
Verwenden Sie die RegisterModule-Methode oder die TBackendQuery-Komponente und die EdgeModule-Ressource, um ein neues EMS-EdgeModule beim EMS-Server zu registrieren.
RegisterModuleResource-Endpunkt
Registriert eine neue Ressource für das EMS-EdgeModule beim EMS-Server.
UpdateModule-Endpunkt
Aktualisiert ein bestehendes EMS-EdgeModule auf dem EMS-Server.
Ihre Anforderung muss das folgende Feld enthalten:
- modulename
Mit der UpdateModule-Methode aktualisieren Sie die Daten aus einem bestehenden EMS-EdgeModule im EMS-Server.
UpdateModuleResource-Endpunkt
Registriert eine bestehende Ressource aus einem EMS-EdgeModule im EMS-Server. Ihre Anforderung muss die folgenden Felder enthalten:
- moduleid
- resourcename
Mit der UpdateModuleResource-Methode aktualisieren Sie die Ressourcendaten aus einem bestehenden EdgeModule im EMS-Server.
UnregisterModule-Endpunkt
Löscht und entfernt ein bestehendes EMS-EdgeModule im EMS-Server.
Ihre Anforderung muss die folgenden Felder enthalten:
- moduleid
Mit der Methode UnregisterModule löschen Sie die Daten aus einem bestehenden EMS-EdgeModule auf dem EMS-Server.
UnregisterModuleResource-Endpunkt
Löscht die bestehende Ressource aus einem EMS-EdgeModule auf dem EMS-Server und hebt deren Registrierung auf. Ihre Anforderung muss die folgenden Felder enthalten:
- moduleid
- resourcename
Mit der Methode UnregisterModuleResource löschen Sie die Ressourcendaten aus einem bestehenden EdgeModule auf dem EMS-Server.
GetResourceEndpoint-Endpunkt
Gibt die Daten vom GET
-Endpunkt aus einer EMS-EdgeModule-Ressource zurück.
Beispielantwort
Dies ist eine Beispielantwort für das Modul WinEdge1 und die Ressource Measurements:
[
{
"device": "heartrate",
"time": "2015-08-17T15:53:07.075Z",
"data": {
"bpm": 68
}
},
{
"device": "bloodpressure",
"time": "2015-08-17T15:54:59.015Z",
"data": {
"systolic": 115,
"diastolic": 77
}
}
]
GetResourceEndpointItem-Endpunkt
Gibt die Daten eines bestimmten GET
-Endpunkts (festgelegt durch das Ressourcensuffix {item}
) aus einer EMS-EdgeModule-Ressource zurück.
Beispielantwort
Dies ist eine Beispielantwort für das Modul WinEdge1, die Ressource Measurements und das Ressourcensuffix detailed
:
[
{
"device": "heartrate",
"time": "2015-08-17T15:53:07.075Z",
"data": {
"bpm": {
"last": 68,
"mean": 69.9354838709677,
"stddev": 1.38889605732917
}
}
},
{
"device": "bloodpressure",
"time": "2015-08-17T15:54:59.015Z",
"data": {
"diastolic": {
"last": 77,
"mean": 76.875,
"stddev": 1.64208056179609
},
"systolic": {
"last": 115,
"mean": 117.125,
"stddev": 1.64208056179609
}
}
}
]
PutResourceEndpoint-Endpunkt
Aktualisiert die Daten eines Ressourcenendpunkts aus einem bestehenden EMS-EdgeModule.
Ihre Anforderung muss die folgenden Felder enthalten:
- modulename
- resourcename
PutResourceEndpointItem-Endpunkt
Aktualisiert die Daten eines bestimmten Endpunkts (festgelegt vom Ressourcensuffix {item}
) einer EMS-EdgeModule-Ressource.
Ihre Anforderung muss die folgenden Felder enthalten:
- modulename
- resourcename
- ResourceSuffix
PostResourceEndpoint-Endpunkt
Fügt dem Ressourcenendpunkt neue Daten aus einem bestehenden EMS-EdgeModule hinzu.
Ihre Anforderung muss die folgenden Felder enthalten:
- modulename
- resourcename
PostResourceEndpointItem-Endpunkt
Fügt einem bestimmten Endpunkt (festgelgt vom Ressourcensuffix {item}
) neue Daten aus einer EMS-EdgeModule-Ressource hinzu.
Ihre Anforderung muss die folgenden Felder enthalten:
- modulename
- resourcename
- ResourceSuffix
PatchResourceEndpoint-Endpunkt
Fordert eine Gruppe von Änderungen an den Daten des Ressourcenendpunkts aus einem bestehenden EMS-EdgeModule an.
Ihre Anforderung muss die folgenden Felder enthalten:
- modulename
- resourcename
PatchResourceEndpointItem-Endpunkt
Fordert eine Gruppe von Änderungen an den Daten eines bestimmten Endpunkts (festgelegt vom Ressourcensuffix {item}
) aus einer EMS-EdgeModule-Ressource an.
Ihre Anforderung muss die folgenden Felder enthalten:
- modulename
- resourcename
- ResourceSuffix
DeleteResourceEndpoint-Endpunkt
Löscht die Daten des Ressourcenendpunkts aus einem bestehenden EMS-EdgeModule.
Ihre Anforderung muss die folgenden Felder enthalten:
- modulename
- resourcename
DeleteResourceEndpointItem-Endpunkt
Löscht die Daten eines bestimmten Endpunkts (festgelegt vom Ressourcensuffix {item}
) aus einer EMS-EdgeModule-Ressource.
Ihre Anforderung muss die folgenden Felder enthalten:
- modulename
- resourcename
- ResourceSuffix
EMS-EdgeModules-Felder
EdgeModules-Ressourcen in EMS-Anforderungen und -Antworten können eine beliebige Kombination der folgenden Felder enthalten:
Element | Beispiel | Beschreibung |
---|---|---|
"modulename"
|
"WinEdge1"
|
EMS-EdgeModule-Name in der EMS-Datenbank. |
"_id"
|
"34C977F1-4DCE-4412-ACE8-35339CEE7282"
|
Eindeutiger Bezeichner des EMS-EdgeModule in der EMS-Datenbank. |
"protocol"
|
"http"
|
Protokollname, der zur Kommunikation zwischen dem EMS-EdgeModule und dem EMS-Server verwendet wird. |
"protocolprops"
|
"{
\"port\":8082,
\"host\":\"localhost\"}"
|
|
"resourcename"
|
"version"
|
Name der Ressourcen, die die EMS-EdgeModule-Funktionalität erweitern. |
"moduleid"
|
"34C977F1-4DCE-4412-ACE8-35339CEE7282"
|
Eindeutiger EMS-EdgeModule-Bezeichner ( |
"_meta"
|
{
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z",
"updated": "2014-08-20T11:09:56.000Z"
}
|
|
Benutzerdefinierte Felder |
"myCustomField": "My Custom Field description"
|
Weitere für das EMS-EdgeModule gespeicherte Informationen. |