Ressource EdgeModules EMS
Remonter à API administrative EMS
La base de données EMS stocke les données sur les EdgeModules EMS recensés dans le serveur EMS. Vous pouvez accéder à ces informations en utilisant la ressource EdgeModules recensée.
Vous pouvez utiliser la ressource EdgeModules EMS afin de recenser, dérecenser ou modifier un EdgeModule EMS et ses ressources dans votre serveur EMS.
- Remarque : Utilisez le composant TEMSClientAPI pour recenser, dérecenser, mettre à jour ou récupérer les informations des données d'un EdgeModule EMS depuis le serveur EMS.
Sommaire
- 1 Points de terminaison de ressource EdgeModules
- 2 Point de terminaison GetModules
- 3 Point de terminaison GetModule
- 4 Point de terminaison GetModulesFields
- 5 Point de terminaison GetResources
- 6 Point de terminaison GetModuleResources
- 7 Point de terminaison GetResourcesFields
- 8 Point de terminaison GetModuleResource
- 9 Point de terminaison RegisterModule
- 10 Point de terminaison RegisterModuleResource
- 11 Point de terminaison UpdateModule
- 12 Point de terminaison UpdateModuleResource
- 13 Point de terminaison UnregisterModule
- 14 Point de terminaison UnregisterModuleResource
- 15 Point de terminaison GetResourceEndpoint
- 16 Point de terminaison GetResourceEndpointItem
- 17 Point de terminaison PutResourceEndpoint
- 18 Point de terminaison PutResourceEndpointItem
- 19 Point de terminaison PostResourceEndpoint
- 20 Point de terminaison PostResourceEndpointItem
- 21 Point de terminaison PatchResourceEndpoint
- 22 Point de terminaison PatchResourceEndpointItem
- 23 Point de terminaison DeleteResourceEndpoint
- 24 Point de terminaison DeleteResourceEndpointItem
- 25 Champs EdgeModules EMS
- 26 Voir aussi
Points de terminaison de ressource EdgeModules
La ressource EdgeModules expose les points de terminaison de ressource EMS suivants :
Nom de méthode du point de terminaison | Suffixe de ressource | Type de requête HTTP | Utilisation |
---|---|---|---|
GetModules |
-- |
HTTP GET |
Pour récupérer toutes les données d'une ressource EdgeModules. |
GetModule |
|
HTTP GET |
Pour récupérer toutes les données d'un EdgeModule. |
GetModulesFields |
|
HTTP GET |
Pour récupérer les noms de champs de tous les EdgeModules EMS. |
GetResources |
|
HTTP GET |
Pour récupérer toutes les données des ressources de tous les EdgeModules. |
GetModuleResources |
|
HTTP GET |
Pour récupérer toutes les données des ressources d'un EdgeModule. |
GetResourcesFields |
|
HTTP GET |
Pour récupérer les noms de champs de toutes les ressources des EdgeModules EMS. |
GetModuleResource |
|
HTTP GET |
Pour récupérer toutes les données d'une ressource d'un EdgeModule. |
RegisterModule |
-- |
HTTP POST |
Pour ajouter un nouveau EdgeModule EMS à la base de données EMS. |
RegisterModuleResource |
|
HTTP POST |
Pour recenser une nouvelle ressource d'un EdgeModule EMS. |
UpdateModule |
|
HTTP PUT |
Pour mettre à jour les données d'un EdgeModule EMS existant. |
UpdateModuleResource |
|
HTTP PUT |
Pour mettre à jour les données d'une ressource existante d'un EdgeModule EMS. |
UnregisterModule |
|
HTTP DELETE |
Pour supprimer un EdgeModule EMS existant. |
UnregisterModuleResource |
|
HTTP DELETE |
Pour supprimer les données d'une ressource existante d'un EdgeModule EMS. |
GetResourceEndpoint |
|
HTTP GET |
Pour obtenir les données du point de terminaison de ressource |
GetResourceEndpointItem |
|
HTTP GET |
Pour récupérer les données d'un point de terminaison spécifique d'une ressource EdgeModule EMS. |
PutResourceEndpoint |
|
HTTP PUT |
Pour mettre à jour les données du point de terminaison de ressource d'un EdgeModule EMS existant. |
PutResourceEndpointItem |
|
HTTP PUT |
Pour mettre à jour les données d'un point de terminaison spécifique d'une ressource EdgeModule EMS. |
PostResourceEndpoint |
|
HTTP POST |
Pour ajouter de nouvelles données au point de terminaison de ressource d'un EdgeModule EMS existant. |
PostResourceEndpointItem |
|
HTTP POST |
Pour récupérer les nouvelles données d'un point de terminaison spécifique depuis une ressource EdgeModule EMS. |
PatchResourceEndpoint |
|
HTTP PATCH |
Pour demander un ensemble de modifications apportées aux données du point de terminaison de ressource d'un EdgeModule EMS existant. |
PatchResourceEndpointItem |
|
HTTP PATCH |
Pour demander un ensemble de modifications apportées aux données d'un point de terminaison spécifique d'une ressource EdgeModule EMS. |
DeleteResourceEndpoint |
|
HTTP DELETE |
Pour supprimer les données du point de terminaison de ressource d'un EdgeModule EMS existant. |
DeleteResourceEndpointItem |
|
HTTP DELETE |
Pour supprimer les données d'un point de terminaison spécifique d'une ressource EdgeModule EMS. |
Point de terminaison GetModules
Renvoie la liste des données de EdgeModules EMS.
Utilisez la méthode QueryModules ou bien les composants TBackendQuery et la ressource EdgeModule pour récupérer la liste de EdgeModules EMS.
En cas de réussite, la réponse du serveur EMS fournit la liste de tous les EdgeModules EMS, avec des détails sur chaque EdgeModule.
- modulename
- _id
- protocole
- protocolprops (port et host)
- _meta (champs creator, created date et updated date)
- Champs personnalisés (facultatif)
Exemple de réponse
Voici un exemple de réponse :
[
{
"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"
}
}
]
Point de terminaison GetModule
Il renvoie les données d'un EdgeModule EMS spécifié.
Votre requête doit fournir le champ suivant :
- _id
Utilisez la méthode RetrieveModule ou le composant TBackendQuery et la ressource EdgeModule pour récupérer ses données.
En cas de réussite, la réponse du serveur EMS fournit un EdgeModule EMS avec les détails suivants :
- modulename
- _id
- protocole
- protocolprops (port et host)
- _meta (champs creator, created date et updated date)
- Champs personnalisés (facultatif)
Exemple de réponse
Voici un exemple de réponse pour le module "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"
}
}
Point de terminaison GetModulesFields
Récupère les noms de champs de tous les EdgeModules EMS depuis la base de données EMS.
Utilisez la méthode RetrieveModulesFields pour récupérer les champs d'un EdgeModule EMS.
En cas de réussite, la réponse du serveur EMS fournit tous les noms de champs des EdgeModules EMS.
- modulename
- _id
- protocole
- protocolprops
- _meta (champs creator, created et updated)
Exemple de réponse
Voici un exemple de réponse :
[
{
"name": "modulename"
},
{
"name": "_id"
},
{
"name": "protocol"
},
{
"name": "protocolprops"
},
{
"name": "_meta",
"fields": [
{
"name": "creator"
},
{
"name": "created"
},
{
"name": "updated"
}
]
}
]
Point de terminaison GetResources
Renvoie la liste de ressources de tous les EdgeModules EMS.
Utilisez la méthode QueryModuleResources ou bien le composant TBackendQuery et la ressource EdgeModule pour récupérer la liste de ressources des EdgeModules EMS.
En cas de réussite, la réponse du serveur EMS fournit la liste des ressources de tous les EdgeModules EMS, avec des détails sur chaque EdgeModule.
- resourcename
- modulename
- moduleid
- _meta (champs creator, created date et updated date)
- Champs personnalisés (facultatif)
Exemple de réponse
Voici un exemple de réponse :
[
{
"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"
}
}
]
Point de terminaison GetModuleResources
Renvoie une liste des données de ressources pour un EdgeModule EMS donné.
Utilisez la méthode QueryModuleResource ou bien le composant TBackendQuery et la ressource EdgeModule pour récupérer la liste de ressources d'un EdgeModule EMS.
En cas de réussite, la réponse du serveur EMS fournit la liste de toutes les ressources d'un EdgeModule EMS, avec des détails sur chaque ressource.
- resourcename
- modulename
- moduleid
- _meta (champs creator, created date et updated date)
- Champs personnalisés (facultatif)
Exemple de réponse
Voici un exemple de réponse pour le module "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"
}
}
]
Point de terminaison GetResourcesFields
Récupère les noms de champs de toutes les ressources de tous les EdgeModules EMS depuis la base de données EMS.
Utilisez la méthode RetrieveModuleResourcesFields pour récupérer les champs des ressources des EdgeModules EMS.
En cas de réussite, la réponse du serveur EMS fournit tous les noms de champs des ressources des EdgeModules EMS.
- resourcename
- modulename
- moduleid
- _meta (champs creator, created et updated)
- users
Exemple de réponse
Voici un exemple de réponse :
[
{
"name": "resourcename"
},
{
"name": "modulename"
},
{
"name": "moduleid"
},
{
"name": "_meta",
"fields": [
{
"name": "creator"
},
{
"name": "created"
},
{
"name": "updated"
}
]
}
]
Point de terminaison GetModuleResource
Renvoie les données d'une ressource donnée pour un EdgeModule EMS.
Utilisez la méthode RetrieveModuleResource ou bien le composant TBackendQuery et la ressource EdgeModule pour récupérer les données d'une ressource d'un EdgeModule EMS.
En cas de réussite, la réponse du serveur EMS fournit toutes les données des ressources d'un EdgeModule EMS, avec des détails sur chacune des données.
- resourcename
- modulename
- moduleid
- _meta (champs creator, created date et updated date)
- Champs personnalisés (facultatif)
Exemple de réponse
Voici un exemple de réponse pour le module "5B2A78B8-2599-433F-956D-720A12FFCD0B" et la 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"
}
}
Point de terminaison RegisterModule
Recense le EdgeModule EMS donné dans le serveur EMS.
Votre requête doit fournir les champs suivants :
- modulename
- protocole
- protocolprops (port et host)
Utilisez la méthode RegisterModule ou bien le composant TBackendQuery et la ressource EdgeModule pour recenser un nouvel EdgeModule EMS dans le serveur EMS.
Point de terminaison RegisterModuleResource
Recense une nouvelle ressource dans le EdgeModule EMS du serveur EMS.
Point de terminaison UpdateModule
Met à jour un EdgeModule existant dans le serveur EMS.
Votre requête doit fournir le champ suivant :
- modulename
Utilisez la méthode UpdateModule pour mettre à jour les données d'un EdgeModule EMS existant dans le serveur EMS.
Point de terminaison UpdateModuleResource
Recense une ressource existante d'un EdgeModule EMS dans le serveur EMS. Votre requête doit fournir les champs suivants :
- moduleid
- resourcename
Utilisez la méthode UpdateModuleResource pour mettre à jour les données de ressource d'un EdgeModule existant dans le serveur EMS.
Point de terminaison UnregisterModule
Supprime et dérecense un EdgeModule EMS existant dans le serveur EMS.
Votre requête doit fournir les champs suivants :
- moduleid
Utilisez la méthode UnregisterModule pour supprimer les données d'un EdgeModule EMS existant dans le serveur EMS.
Point de terminaison UnregisterModuleResource
Supprime et dérecense la ressource existante d'un EdgeModule EMS dans le serveur. Votre requête doit fournir les champs suivants :
- moduleid
- resourcename
Utilisez la méthode UnregisterModuleResource pour supprimer les données de ressource d'un EdgeModule dans le serveur EMS.
Point de terminaison GetResourceEndpoint
Renvoie les données d'un point de terminaison GET
d'une ressource EdgeModule EMS.
Exemple de réponse
Voici un exemple de réponse pour le module WinEdge1 et la 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
}
}
]
Point de terminaison GetResourceEndpointItem
Renvoie les données d'un point de terminaison GET
spécifique (spécifié par le suffixe de ressource {item}
) d'une ressource EdgeModule EMS.
Exemple de réponse
Voici un exemple de réponse pour le module WinEdge1, la ressource Measurements et le suffixe de ressource 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
}
}
}
]
Point de terminaison PutResourceEndpoint
Met à jour les données du point de terminaison de ressource d'un EdgeModule EMS existant.
Votre requête doit fournir les champs suivants :
- modulename
- resourcename
Point de terminaison PutResourceEndpointItem
Met à jour les données d'un point de terminaison spécifique (spécifié par le suffixe de ressource {item}
) d'une ressource de EdgeModule EMS.
Votre requête doit fournir les champs suivants :
- modulename
- resourcename
- Suffixe de ressource
Point de terminaison PostResourceEndpoint
Ajoute de nouvelles données au point de terminaison de ressource d'un EdgeModule EMS existant.
Votre requête doit fournir les champs suivants :
- modulename
- resourcename
Point de terminaison PostResourceEndpointItem
Ajoute de nouvelles données à un point de terminaison spécifique (spécifié par le suffixe de ressource {item}
) d'une ressource EdgeModule EMS.
Votre requête doit fournir les champs suivants :
- modulename
- resourcename
- Suffixe de ressource
Point de terminaison PatchResourceEndpoint
Demande un ensemble de modifications des données du point de terminaison de ressource d'un EdgeModule EMS existant.
Votre requête doit fournir les champs suivants :
- modulename
- resourcename
Point de terminaison PatchResourceEndpointItem
Demande un ensemble de modifications apportées aux données d'un point de terminaison spécifique (spécifié par le suffixe de ressource {item}
) d'une ressource EdgeModule EMS.
Votre requête doit fournir les champs suivants :
- modulename
- resourcename
- Suffixe de ressource
Point de terminaison DeleteResourceEndpoint
Supprime les données du point de terminaison de ressource d'un EdgeModule EMS existant.
Votre requête doit fournir les champs suivants :
- modulename
- resourcename
Point de terminaison DeleteResourceEndpointItem
Supprime les données d'un point de terminaison spécifique (spécifié par le suffixe {item}
) d'une ressource EdgeModule EMS.
Votre requête doit fournir les champs suivants :
- modulename
- resourcename
- Suffixe de ressource
Champs EdgeModules EMS
La ressource Edgemodules de la requête EMS et les réponses peuvent inclure toute combinaison des champs suivants :
Elément | Exemple | Description |
---|---|---|
"modulename"
|
"WinEdge1"
|
Le nom du EdgeModule EMS dans la base de données EMS. |
"_id"
|
"34C977F1-4DCE-4412-ACE8-35339CEE7282"
|
Identificateur de EdgeModule EMS unique dans la base de données EMS. |
"protocol"
|
"http"
|
Nom de protocole utilisé pour la communication entre le EdgeModule EMS et le serveur EMS. |
"protocolprops"
|
"{
\"port\":8082,
\"host\":\"localhost\"}"
|
|
"resourcename"
|
"version"
|
Nom des ressources qui étendent la fonctionnalité du EdgeModule EMS. |
"moduleid"
|
"34C977F1-4DCE-4412-ACE8-35339CEE7282"
|
Identificateur de EdgeModule EMS unique ( |
"_meta"
|
{
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z",
"updated": "2014-08-20T11:09:56.000Z"
}
|
|
Champs personnalisés |
"myCustomField": "My Custom Field description"
|
Informations stockées supplémentaires pour le EdgeModule EMS. |