RAD Server-Ressource "Gruppen"
Nach oben zu RAD Server Administrative API
In der EMS-Datenbank werden Daten über die Gruppen von registrierten Benutzern Ihrer Anwendung gespeichert. Mit der Ressource "Gruppe" können Sie auf diese Informationen zugreifen.
Mit den EMS-Gruppen können Sie eine Gruppe von EMS-Benutzern für den Zugriff auf eine bestimmte EMS-Ressource Ihres EMS-Servers autorisieren (Zugriff erteilen oder verwehren) (abhängig von den Anmeldeinformationen in der HTTP-Anforderung).
- Hinweis: Verwenden Sie die Komponente TEMSClientAPI oder TBackendGroups, um EMS-Gruppen zu erstellen, zu aktualisieren oder zu löschen oder um vorhandenen EMS-Gruppen EMS-Benutzer hinzuzufügen.
Inhaltsverzeichnis
Endpunkte der Ressource "Gruppen"
Die Ressource "Gruppen" stellt die folgenden EMS-Ressourcenendpunkte bereit:
| Name der Endpunktmethode | Ressourcensuffix | HTTP-Anforderungstyp | Verwendung |
|---|---|---|---|
|
GetGroups |
-- |
HTTP GET |
Zum Abrufen aller Daten aus der Ressource "Gruppen". |
|
GetGroup |
|
HTTP GET |
Zum Abrufen aller Daten aus einer Gruppe. |
|
GetGroupFields |
|
HTTP GET |
Zum Abrufen der Feldnamen aller EMS-Gruppen. |
|
AddGroup |
-- |
HTTP POST |
Zum Hinzufügen einer neuen Gruppe zu der EMS-Datenbank. |
|
UpdateGroup |
|
HTTP PUT |
Zum Aktualisieren einer Gruppe in der EMS-Datenbank. |
|
DeleteGroup |
|
HTTP DELETE |
Zum Löschen einer Gruppe aus der EMS-Datenbank. |
GetGroups-Endpunkt
Gibt eine Liste der EMS-Gruppendaten zurück.
Verwenden Sie die Methode QueryGroups oder die Komponente TBackendGroups oder TBackendQuery und die Ressource "Gruppen", um die Liste der EMS-Benutzer abzurufen.
Bei Erfolg enthält die Antwort vom EMS-Server eine Liste aller EMS-Gruppen mit Einzelheiten zu jeder Gruppe.
- name
- _meta (Felder "creator", "created date" und "updated date")
- users
- Benutzerdefinierte Felder (optional)
Beispielantwort
So könnte eine Antwort vom Server aussehen:
[
{
"name": "testgroup",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z"
},
"description": "Created by EMS setup.",
"users": [
"24EDA495-90FC-4BC4-9626-C87783357948"
]
},
{
"name": "admins",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z",
"updated": "2014-08-20T11:09:56.000Z"
},
"users": [
"24EDA495-90FC-4BC4-9626-C87783357948",
"AB4900CC-CD7A-4890-B20D-9A3E65B450C7"
]
}
]
GetGroup-Endpunkt
Gibt die Daten einer angegebenen EMS-Gruppe zurück.
Ihre Anforderung muss das folgende Feld enthalten:
- name
Verwenden Sie die Methode RetrieveGroup oder die Komponente TBackendGroups oder TBackendQuery und den Gruppennamen, um diese Daten abzurufen.
Bei Erfolg enthält die Antwort vom EMS-Server die EMS-Gruppe mit Einzelheiten.
- name
- _meta (Felder "creator", "created" und "updated")
- users
- Benutzerdefinierte Felder (optional)
Beispielantwort
Beispielantwort auf die Anforderung für den Gruppennamen "testgroup":
{
"name": "testgroup",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z"
},
"description": "Created by EMS setup.",
"users": [
"24EDA495-90FC-4BC4-9626-C87783357948"
]
}
GetFields-Endpunkt
Ruft die Feldnamen aller EMS-Gruppen aus der EMS-Datenbank ab.
Mit der Methode RetrieveGroupsFields rufen Sie die Felder einer EMS-Gruppe ab.
Bei Erfolg enthält die Antwort vom EMS-Server alle Feldnamen der EMS-Gruppen.
- name
- _meta (Felder "creator", "created" und "updated")
- users
Beispielantwort
So könnte eine Antwort vom Server aussehen:
[
{
"name":"groupname"
},
{
"name":"_meta",
"fields":[
{
"name":"creator"
},
{
"name":"created"
},
{
"name":"updated"
}
]
},
{
"name":"users"
},
{
"name":"description",
"custom":true
}
]
AddGroup-Endpunkt
Fügt der EMS-Datenbank eine neue Gruppe hinzu.
Ihre Anforderung muss das folgende Feld enthalten:
- name
Verwenden Sie die Methode TEMSClientAPI.CreateGroup oder die Methode CreateGroup der Komponente TBackendGroups, um eine neue EMS-Gruppe hinzuzufügen.
UpdateGroup-Endpunkt
Aktualisiert die Daten einer vorhandenen EMS-Gruppe, die in der EMS-Datenbank gespeichert ist.
Ihre Anforderung muss mindestens das folgende Feld enthalten:
- name
Verwenden Sie die Methode TEMSClientAPI.UpdateGroup oder die Methode UpdateGroup der Komponente TBackendGroups, um die Daten einer vorhandenen EMS-Gruppe zu aktualisieren.
DeleteGroup-Endpunkt
Löscht eine vorhandene EMS-Gruppe aus der EMS-Datenbank.
Ihre Anforderung muss das folgende Feld enthalten:
- name
Verwenden Sie die Methode TEMSClientAPI.DeleteGroup oder die Methode DeleteGroup der Komponente TBackendGroups, um eine vorhandene EMS-Gruppe zu löschen.
Felder für EMS-Gruppen
Die EMS-Anforderung von und Antworten zu der Ressource "Gruppen" können eine beliebige Kombination der folgenden Felder enthalten:
| Element | Beispiel | Beschreibung |
|---|---|---|
"name"
|
"admins"
|
Eindeutiger EMS-Gruppenname in der EMS-Datenbank. |
"_meta"
|
{
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z",
"updated": "2014-08-20T11:09:56.000Z"
}
|
|
"users"
|
[
"24EDA495-90FC-4BC4-9626-C87783357948",
"AB4900CC-CD7A-4890-B20D-9A3E65B450C7"
]
|
Liste der EMS-Benutzer, die zu dieser EMS-Gruppe gehören. |
|
Benutzerdefinierte Felder |
"myCustomField": "My Custom Field description"
|
Weitere für die EMS-Gruppe gespeicherte Informationen. |