RAD Server-Ressource "Installationen"

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu RAD Server Administrative API


Die EMS-Datenbank speichert Daten über die registrierten Geräte einer Anwendung für EMS-Push-Benachrichtigungen. Mit der Ressource "Installationen" können Sie auf diese Informationen zugreifen.

Sie können EMS-Push-Benachrichtigungen an die EMS-Installationen (registrierte Geräte) mit der Anwendung "EMS Management Console" senden.

Hinweis: Registrieren Sie mit den Komponenten TEMSClientAPI und TCustomPushEvents ein neues Gerät (EMS-Installation), und rufen Sie Daten aus der EMS-Ressource "Installationen" ab.

Endpunkte der Ressource "Installationen"

Die Ressource "Installationen" stellt die folgenden EMS-Ressourcenendpunkte bereit:

Name der Endpunktmethode Ressourcensuffix HTTP-Anforderungstyp Verwendung

GetInstallations

--

HTTP GET

Zum Abrufen aller Daten aus der Ressource "Installationen".

GetChannels

channels

HTTP GET

Zum Abrufen der verfügbaren Kanäle, die das Gerät abonniert hat.

GetInstallationFields

fields

HTTP GET

Zum Abrufen der Feldnamen aller EMS-Installationen.

GetInstallation

{id}

HTTP GET

Zum Abrufen aller Daten aus einer bestimmten Installation (registriertes Gerät).
id ist der eindeutige Bezeichner der EMS-Installation in der EMS-Datenbank.

AddInstallation

--

HTTP POST

Zum Hinzufügen einer neuen EMS-Installation zu der EMS-Datenbank.

UpdateInstallation

{id}

HTTP PUT

Zum Aktualisieren der EMS-Installationsfelder in der EMS-Datenbank.
id ist der eindeutige Bezeichner der EMS-Installation in der EMS-Datenbank.

DeleteInstallation

{id}

HTTP DELETE

Zum Löschen einer Installation aus der EMS-Datenbank.
id ist der eindeutige Bezeichner der EMS-Installation in der EMS-Datenbank.

GetInstallations-Endpunkt

Gibt eine Liste der EMS-Installationsdaten zurück.

Mit der Methode QueryInstallations rufen Sie die Liste der EMS-Installationen ab.

Bei Erfolg enthält die Antwort vom EMS-Server eine Liste aller EMS-Installationen mit Einzelheiten zu jeder Installation.

  • _id
  • deviceToken
  • deviceType
  • _meta (Felder "creator", "created" und "updated")
  • channels
  • Benutzerdefinierte Felder (optional)

Beispielantwort

So könnte eine Antwort vom Server aussehen: 

[  
   {  
      "_id":"384234D0-7CEC-4C29-8363-2CED46ACAD39",
      "deviceToken":"APA91bEIMc7Q8mhbGW8hJM44y5oOU3x-zAlJ37W_NThA1HOZeZY9AmMkziY-Ri-REh1m-Qa8Dw2paBDTwXXZNrY1qa8nAFQGjXYaiS_5hiJ3cZDL7OB1zkcya4JoJCpUccmvm49yXHmcqBKC32rk23PKib8ZYyBmX_wgZhwM_vBozhKJ821wXDI",
      "deviceType":"android",
      "_meta":{  
         "creator":"00000000-0000-0000-0000-000000000000",
         "created":"2015-02-06T10:05:01.000Z",
         "updated":"2015-02-06T10:06:34.000Z"
      },
      "description":"Nexus 7 device.",
      "channels":[  
         "News"
      ]
   },
   {  
      "_id":"92690E39-889C-4CC1-9B54-404ABB0604A3",
      "deviceToken":"APA91bG5a4a4HMACivEP2hH-x_7PUIW8GT4lvdHQWGfnh0KB7lRTwDMyS-2cHqw4gJGj_kSTXHt6DRiuA5Zr_26d1la83nlUfBuPUPXfq_8IAuQBH7thf22_X9RWCJbbcj27OEkUx0u5ylno-RTOFR1rTicxkBai6sYqPLzmvJeySwyDdyQnk9o",
      "deviceType":"android",
      "_meta":{  
         "creator":"00000000-0000-0000-0000-000000000000",
         "created":"2015-02-06T10:55:03.000Z"
      },
      "channels":[  

      ]
   }
]

GetChannels-Endpunkt

Gibt eine Liste der verfügbaren Kanäle, die das Gerät abonniert hat, zurück.

Mit der Methode RetrieveInstallationsChannelNames rufen Sie die Liste der verfügbaren Kanäle ab.

Bei Erfolg enthält die Antwort vom EMS-Server eine Liste aller verfügbaren Kanäle.

Beispielantwort

So könnte eine Antwort vom Server aussehen: 

[  
   "News",
   "Weather"
]

GetFields-Endpunkt

Ruft die Feldnamen aller EMS-Installationen aus der EMS-Datenbank ab.

Mit der Methode RetrieveInstallationsFields rufen Sie die Feldnamen aller EMS-Installationen ab.

Bei Erfolg enthält die Antwort vom EMS-Server alle Feldnamen der EMS-Installation.

  • _id
  • deviceToken
  • deviceType
  • _meta (Felder "creator", "created" und "updated")
  • channels
  • Benutzerdefinierte Felder (optional)

Beispielantwort

So könnte eine Antwort vom Server aussehen: 

[  
   {  
      "name":"_id"
   },
   {  
      "name":"deviceToken"
   },
   {  
      "name":"deviceType"
   },
   {  
      "name":"_meta",
      "fields":[  
         {  
            "name":"creator"
         },
         {  
            "name":"created"
         },
         {  
            "name":"updated"
         }
      ]
   },
   {  
      "name":"channels"
   },
   {  
      "name":"description",
      "custom":true
   }
]

GetInstallation-Endpunkt

Ruft alle Daten aus einer angegebenen (durch die id bezeichneten) EMS-Installation zurück.

Ihre Anforderung muss mindestens das folgende Feld enthalten:

  • _id

Mit der Methode RetrieveInstallations rufen Sie die Felder einer EMS-Installation ab.

Bei Erfolg enthält die Antwort vom EMS-Server alle Feldnamen der EMS-Installation.

  • _id
  • deviceToken
  • deviceType
  • _meta (Felder "creator", "created" und "updated")
  • channels
  • Benutzerdefinierte Felder (optional)

Beispielantwort

Dies ist eine Beispielantwort für die EMS-Installation mit der ID "384234D0-7CEC-4C29-8363-2CED46ACAD39". 

{  
   "_id":"384234D0-7CEC-4C29-8363-2CED46ACAD39",
   "deviceToken":"APA91bEIMc7Q8mhbGW8hJM44y5oOU3x-zAlJ37W_NThA1HOZeZY9AmMkziY-Ri-REh1m-Qa8Dw2paBDTwXXZNrY1qa8nAFQGjXYaiS_5hiJ3cZDL7OB1zkcya4JoJCpUccmvm49yXHmcqBKC32rk23PKib8ZYyBmX_wgZhwM_vBozhKJ821wXDI",
   "deviceType":"android",
   "_meta":{  
      "creator":"00000000-0000-0000-0000-000000000000",
      "created":"2015-02-06T10:05:01.000Z",
      "updated":"2015-02-06T11:58:57.000Z"
   },
   "description":"Nexus 7 device",
   "channels":[  
      "News",
      "Weather"
   ]
}

AddInstallation-Endpunkt

Fügt der EMS-Datenbank eine neue Installation (registriertes Gerät) hinzu.

Mit der Methode RegisterDevice registrieren Sie eine neue EMS-Installation.

UpdateInstallation-Endpunkt

Aktualisiert die Daten einer vorhandenen EMS-Installation, die in der EMS-Datenbank gespeichert ist.

Ihre Anforderung muss mindestens das folgende Feld enthalten:

  • _id

Mit der Methode UpdateInstallation aktualisieren Sie die Daten einer vorhandenen EMS-Installation.

DeleteInstallation-Endpunkt

Löscht eine vorhandene EMS-Installation aus der EMS-Datenbank.

Ihre Anforderung muss das folgende Feld enthalten:

  • _id

Mit der Methode DeleteInstallation löschen Sie eine vorhandene EMS-Installation.

Felder von EMS-Installationen

Installationsressourcen in EMS-Anforderungen und -Antworten können eine beliebige Kombination der folgenden Felder enthalten:

Element Beispiel Beschreibung 
"_id"

"384234D0-7CEC-4C29-8363-2CED46ACAD39"

Eindeutiger Bezeichner der EMS-Installation in der EMS-Datenbank. 

"deviceToken"

"APA91bEIMc7Q8mhbGW8hJM44y5oOU3x-zAlJ37W[...]vBozhKJ821wXDI"

Eindeutiger Bezeichner der EMS-Installation in der EMS-Datenbank. 

"deviceType"

"android"

Typ des Geräts (ios, android, winrt, winphone, dotnet). 

"_meta"

{
    "creator":"00000000-0000-0000-0000-000000000000",
    "created":"2015-02-06T10:05:01.000Z",
    "updated":"2015-02-06T10:06:34.000Z"
}
  • creator: Ersteller der EMS-Installation in der EMS-Datenbank.
  • created: Erstellungsdatum der EMS-Installation.
  • updated: Zeitpunkt, an dem die EMS-Installation aktualisiert wurde.
"channels"

[
    "News",
    "Weather"
]

Liste der verfügbaren Kanäle, die das Gerät abonniert hat.

Benutzerdefinierte Felder 

"myCustomField": "My Custom Field description"

Weitere für die EMS-Installation gespeicherte Informationen.

Siehe auch

Abgerufen von „https://docwiki.embarcadero.com/RADStudio/Alexandria/d/index.php?title=RAD_Server-Ressource_%22Installationen%22&oldid=214048“