RAD サーバー エッジモジュール

提供: RAD Studio
移動先: 案内、 検索

RAD サーバー管理用 API への移動


EMS データベースには、EMS サーバーに登録された EMS エッジモジュールに関するデータが格納されています。登録されているエッジモジュール リソースを使って、この情報にアクセスすることができます。

EMS エッジモジュール リソースを使用して、EMS サーバー内の EMS エッジモジュールおよびそのリソースの登録、登録解除、変更を行うことができます。

メモ： TEMSClientAPI コンポーネントを使用して、EMS サーバー内の EMS エッジモジュールの登録、登録解除、更新、データ情報の取得を行うことができます。

エッジモジュール リソース エンドポイント

エッジモジュール リソースでは、次の EMS リソース エンドポイントを公開しています。

エンドポイント メソッド名 リソース サフィックス HTTP 要求の種類 用途

GetModules

--

HTTP GET

エッジモジュール リソースからすべてのデータを取得すること。

GetModule

{id}

HTTP GET

エッジモジュールからすべてのデータを取得すること。
id は EMS データベース内で一意の EMS エッジモジュール識別子。

GetModulesFields

fields

HTTP GET

すべての EMS エッジモジュールのフィールド名を取得すること。

GetResources

resources

HTTP GET

すべてのエッジモジュールのリソースからすべてのデータを取得すること。

GetModuleResources

{id}/resources

HTTP GET

1 つのエッジモジュールのリソースからすべてのデータを取得すること。
id は EMS データベース内で一意の EMS エッジモジュール識別子。

GetResourcesFields

resources/fields

HTTP GET

EMS エッジモジュールのすべてのリソースのフィールド名を取得すること。

GetModuleResource

{id}/resources/{resourcename}

HTTP GET

1 つのエッジモジュールのリソースからすべてのデータを取得すること。
id は EMS データベース内で一意の EMS エッジモジュール識別子。
resourcename はリソースの名前。

RegisterModule

--

HTTP POST

EMS データベースに新しい EMS エッジモジュールを追加すること。

RegisterModuleResource

{id}/resources

HTTP POST

EMS エッジモジュールの新しいリソースを登録すること。
id は EMS データベース内で一意の EMS エッジモジュール識別子。

UpdateModule

{id}

HTTP PUT

既存の EMS エッジモジュールのデータを更新すること。
id は EMS データベース内で一意の EMS エッジモジュール識別子。

UpdateModuleResource

{id}/resources/{resourcename}

HTTP PUT

EMS エッジモジュールの既存のリソースのデータを更新すること。
id は EMS データベース内で一意の EMS エッジモジュール識別子。
resourcename はリソースの名前。

UnregisterModule

{id}

HTTP DELETE

既存の EMS エッジモジュールを削除すること。
id は EMS データベース内で一意の EMS エッジモジュール識別子。

UnregisterModuleResource

{id}/resources/{resourcename}

HTTP DELETE

EMS エッジモジュールの既存のリソースのデータを削除すること。
id は EMS データベース内で一意の EMS エッジモジュール識別子。
resourcename はリソースの名前。

GetResourceEndpoint

{modulename}/{resourcename}

HTTP GET

既存の EMS エッジモジュールの GET リソース エンドポイントからデータを取得すること。
modulename は EMS データベース内の EMS エッジモジュール名。
resourcename は EMS データベース内の EMS エッジモジュールのリソース名。

GetResourceEndpointItem

{modulename}/{resourcename}/{item}

HTTP GET

EMS エッジモジュール リソースから特定のエンドポイントのデータを取得すること。
modulename は EMS データベース内の EMS エッジモジュール名。
resourcename は EMS データベース内の EMS エッジモジュールのリソース名。
item はエンドポイントを特定するためのリソース サフィックス。

PutResourceEndpoint

{modulename}/{resourcename}

HTTP PUT

既存の EMS エッジモジュールのリソース エンドポイントのデータを更新すること。
modulename は EMS データベース内の EMS エッジモジュール名。
resourcename は EMS データベース内の EMS エッジモジュールのリソース名。

PutResourceEndpointItem

{modulename}/{resourcename}/{item}

HTTP PUT

EMS エッジモジュール リソースの特定のエンドポイントのデータを更新すること。
modulename は EMS データベース内の EMS エッジモジュール名。
resourcename は EMS データベース内の EMS エッジモジュールのリソース名。
item はエンドポイントを特定するためのリソース サフィックス。

PostResourceEndpoint

{modulename}/{resourcename}

HTTP POST

既存の EMS エッジモジュールのリソース エンドポイントに新しいデータを追加すること。
modulename は EMS データベース内の EMS エッジモジュール名。
resourcename は EMS データベース内の EMS エッジモジュールのリソース名。

PostResourceEndpointItem

{modulename}/{resourcename}/{item}

HTTP POST

EMS エッジモジュール リソースの特定のエンドポイントに新しいデータを追加すること。
modulename は EMS データベース内の EMS エッジモジュール名。
resourcename は EMS データベース内の EMS エッジモジュールのリソース名。
item はエンドポイントを特定するためのリソース サフィックス。

PatchResourceEndpoint

{modulename}/{resourcename}

HTTP PATCH

既存の EMS エッジモジュールのリソース エンドポイントのデータに対する一連の変更を要求すること。
modulename は EMS データベース内の EMS エッジモジュール名。
resourcename は EMS データベース内の EMS エッジモジュールのリソース名。

PatchResourceEndpointItem

{modulename}/{resourcename}/{item}

HTTP PATCH

EMS エッジモジュール リソースの特定のエンドポイントのデータに対する一連の変更を要求すること。
modulename は EMS データベース内の EMS エッジモジュール名。
resourcename は EMS データベース内の EMS エッジモジュールのリソース名。
item はエンドポイントを特定するためのリソース サフィックス。

DeleteResourceEndpoint

{modulename}/{resourcename}

HTTP DELETE

既存の EMS エッジモジュールのリソース エンドポイントのデータを削除すること。
modulename は EMS データベース内の EMS エッジモジュール名。
resourcename は EMS データベース内の EMS エッジモジュールのリソース名。

DeleteResourceEndpointItem

{modulename}/{resourcename}/{item}

HTTP DELETE

EMS エッジモジュール リソースの特定のエンドポイントのデータを削除すること。
modulename は EMS データベース内の EMS エッジモジュール名。
resourcename は EMS データベース内の EMS エッジモジュールのリソース名。
item はエンドポイントを特定するためのリソース サフィックス。

GetModules エンドポイント

EMS エッジモジュール データのリストを返します。

QueryModules メソッド、または TBackendQuery コンポーネントとエッジモジュール リソースを使用すると、EMS エッジモジュールのリストを取得できます。

正常終了した場合、EMS サーバーからの応答は全 EMS エッジモジュールのリストと各エッジモジュールについての詳細を示します。

  • modulename
  • _id
  • protocol
  • protocolprops（ポートおよびホスト）
  • _meta（creator、created date、updated date の各フィールド）
  • カスタム フィールド（省略可能）

応答の例

次は応答の例です。 

[
    {
        "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 エンドポイント

指定された EMS エッジモジュールのデータを返します。

要求には、次のフィールドを指定する必要があります。

  • _id

RetrieveModule メソッド、または TBackendQuery コンポーネントとエッジモジュール リソースを使用すると、そのデータを取得できます。

正常終了した場合、EMS サーバーからの応答は EMS エッジモジュールと以下の詳細を示します。

  • modulename
  • _id
  • protocol
  • protocolprops（ポートおよびホスト）
  • _meta（creator、created date、updated date の各フィールド）
  • カスタム フィールド（省略可能）

応答の例

これは、"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 エンドポイント

EMS データベースからすべての EMS エッジモジュールのフィールド名を取得します。

RetrieveModulesFields メソッドを使用すると、EMS エッジモジュールのフィールドを取得できます。

正常終了した場合は、EMS エッジモジュールのすべてのフィールド名を並べたリストが EMS サーバーからの応答になります。

  • modulename
  • _id
  • protocol
  • protocolprops
  • _meta（creator、created、updated の各フィールド）

応答の例

次は応答の例です。 

[
    {
        "name": "modulename"
    },
    {
        "name": "_id"
    },
    {
        "name": "protocol"
    },
    {
        "name": "protocolprops"
    },
    {
        "name": "_meta",
        "fields": [
            {
                "name": "creator"
            },
            {
                "name": "created"
            },
            {
                "name": "updated"
            }
        ]
    }
]

GetResources エンドポイント

すべての EMS エッジモジュールのリソースのリストを返します。

QueryModuleResources メソッドまたは TBackendQuery コンポーネントとエッジモジュール リソースを使用すると、EMS エッジモジュールからリソースのリストを取得できます。

正常終了した場合、EMS サーバーからの応答は全 EMS エッジモジュールのリソースのリストと各エッジモジュールについての詳細を示します。

  • resourcename
  • modulename
  • moduleid
  • _meta（creator、created date、updated date の各フィールド）
  • カスタム フィールド（省略可能）

応答の例

次は応答の例です。 

[
    {
        "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 エンドポイント

指定された EMS エッジモジュールのリソース データのリストを返します。

QueryModuleResource メソッド、または TBackendQuery コンポーネントとエッジモジュール リソースを使用すると、EMS エッジモジュールからリソースのリストを取得できます。

正常終了した場合、EMS サーバーからの応答は EMS エッジモジュールの全リソースのリストと各リソースについての詳細を示します。

  • resourcename
  • modulename
  • moduleid
  • _meta（creator、created date、updated date の各フィールド）
  • カスタム フィールド（省略可能）

応答の例

これは、"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 エンドポイント

EMS データベースからすべての EMS エッジモジュールのすべてのリソースのフィールド名を取得します。

RetrieveModuleResourcesFields メソッドを使用すると、EMS エッジモジュールからリソースのフィールドを取得できます。

正常終了した場合は、EMS エッジモジュールからリソースのすべてのフィールド名を並べたリストが EMS サーバーからの応答になります。

  • resourcename
  • modulename
  • moduleid
  • _meta（creator、created、updated の各フィールド）
  • users

応答の例

次は応答の例です。 

[
    {
        "name": "resourcename"
    },
    {
        "name": "modulename"
    },
    {
        "name": "moduleid"
    },
    {
        "name": "_meta",
        "fields": [
            {
                "name": "creator"
            },
            {
                "name": "created"
            },
            {
                "name": "updated"
            }
        ]
    }
]

GetModuleResource エンドポイント

EMS エッジモジュールの指定されたリソースのデータを返します。

RetrieveModuleResource メソッド、または TBackendQuery コンポーネントとエッジモジュール リソースを使用すると、EMS エッジモジュールからリソースのデータを取得できます。

正常終了した場合は、各 EMS エッジモジュールの次のような詳細情報を EMS エッジモジュールのリソースからすべてのデータが EMS サーバーからの応答になります。

  • resourcename
  • modulename
  • moduleid
  • _meta（creator、created date、updated date の各フィールド）
  • カスタム フィールド（省略可能）

応答の例

これは、"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"
    }
}


RegisterModule エンドポイント

EMS サーバーに指定された EMS エッジモジュールを登録します。

要求には、次のフィールドを指定する必要があります。

  • modulename
  • protocol
  • protocolprops（ポートおよびホスト）

RegisterModule メソッドまたは TBackendQuery コンポーネントとエッジモジュール リソースを使用すると、EMS サーバーに新しい EMS エッジモジュールを登録できます。

RegisterModuleResource エンドポイント

EMS サーバーの EMS エッジモジュールに新しいリソースを登録します。

UpdateModule エンドポイント

EMS サーバーで既存の EMS エッジモジュールを更新します。

要求には、次のフィールドを指定する必要があります。

  • modulename

UpdateModule メソッドを使用すると、EMS サーバーで既存の EMS エッジモジュールからデータを更新できます。

UpdateModuleResource エンドポイント

EMS サーバーに EMS エッジモジュールから既存のリソースを登録します。 要求には、次のフィールドを指定する必要があります。

  • moduleid
  • resourcename

UpdateModuleResource メソッドを使用すると、EMS サーバーで既存のエッジモジュールからリソース データを更新できます。

UnregisterModule エンドポイント

EMS サーバーで既存の EMS エッジモジュールを削除および登録解除します。

要求には、次のフィールドを指定する必要があります。

  • moduleid

UnregisterModule メソッドを使用すると、EMS サーバーで既存の EMS エッジモジュールからデータを削除できます。

UnregisterModuleResource エンドポイント

EMS サーバーで EMS エッジモジュールから既存のリソースを削除および登録解除します。 要求には、次のフィールドを指定する必要があります。

  • moduleid
  • resourcename

UnregisterModuleResource メソッドを使用すると、EMS サーバーで既存のエッジモジュールからリソース データを削除できます。

GetResourceEndpoint エンドポイント

EMS エッジモジュール リソースの GET エンドポイントからデータを返します。

応答の例

これは、WinEdge1 モジュールと 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 エンドポイント

EMS エッジモジュール リソースの特定の GET エンドポイント（{item} リソース サフィックスで指定）からデータを返します。

応答の例

これは、WinEdge1 モジュール、Measurements リソース、詳細なリソース サフィックスの場合の応答例です。 

[
    {
        "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 エンドポイント

既存 EMS エッジモジュールのリソース エンドポイントからデータを更新します。

要求には、次のフィールドを指定する必要があります。

  • modulename
  • resourcename

PutResourceEndpointItem エンドポイント

EMS エッジモジュール リソースから特定のエンドポイント（{item} リソース サフィックスで指定）のデータを更新します。

要求には、次のフィールドを指定する必要があります。

  • modulename
  • resourcename
  • リソース サフィックス

PostResourceEndpoint エンドポイント

既存の EMS エッジモジュールからリソース エンドポイントに新しいデータを追加します。

要求には、次のフィールドを指定する必要があります。

  • modulename
  • resourcename

PostResourceEndpointItem エンドポイント

EMS エッジモジュール リソースから特定のエンドポイント（{item} リソース サフィックスで指定）に新しいデータを追加します。

要求には、次のフィールドを指定する必要があります。

  • modulename
  • resourcename
  • リソース サフィックス

PatchResourceEndpoint エンドポイント

既存の EMS エッジモジュールからリソース エンドポイントのデータに一連の変更を要求します。

要求には、次のフィールドを指定する必要があります。

  • modulename
  • resourcename

PatchResourceEndpointItem エンドポイント

EMS エッジモジュール リソースから特定のエンドポイント（{item} リソース サフィックスで指定）のデータに一連の変更を要求します。

要求には、次のフィールドを指定する必要があります。

  • modulename
  • resourcename
  • リソース サフィックス

DeleteResourceEndpoint エンドポイント

既存の EMS エッジモジュールからリソース エンドポイントのデータを削除します。

要求には、次のフィールドを指定する必要があります。

  • modulename
  • resourcename

DeleteResourceEndpointItem エンドポイント

EMS エッジモジュール リソースから特定のエンドポイント（{item} リソース サフィックスで指定）のデータを削除します。

要求には、次のフィールドを指定する必要があります。

  • modulename
  • resourcename
  • リソース サフィックス

EMS エッジモジュールのフィールド

EMS 要求および応答におけるエッジモジュール リソースには、次のフィールドの任意の組み合わせが含まれる可能性があります。

項目 例 説明 
"modulename"

"WinEdge1"

EMS データベースでの EMS エッジモジュール名。 

"_id"

"34C977F1-4DCE-4412-ACE8-35339CEE7282"

EMS データベース内で一意の EMS エッジモジュール識別子。 

"protocol"

"http"

EMS エッジモジュールと EMS サーバーの間の通信に使用するプロトコル名。 

"protocolprops"

"{
\"port\":8082,
\"host\":\"localhost\"}"
  • port： EMS エッジモジュール サービスが EMS サーバーからの要求をリスンしている接続ポート。
  • host： EMS エッジモジュールが動作しているホストの情報。
"resourcename"

"version"

EMS エッジモジュール機能を拡張しているリソースの名前。 

"moduleid"

"34C977F1-4DCE-4412-ACE8-35339CEE7282"

リソースを登録している EMS エッジモジュールの一意識別子（_id）。 

"_meta"

{
    "creator": "00000000-0000-0000-0000-000000000001",
    "created": "2014-08-20T11:08:56.000Z",
    "updated": "2014-08-20T11:09:56.000Z"
}
  • creator： EMS データベース内の EMS エッジモジュールまたは EMS エッジモジュール リソースの作成オブジェクト。
  • created： EMS エッジモジュールまたは EMS エッジモジュール リソースの登録日時。
  • updated： EMS エッジモジュールまたは EMS エッジモジュール リソースの更新日時。

カスタム フィールド 

"myCustomField": "My Custom Field description"

EMS エッジモジュールに関して格納されている追加情報。

関連項目

「http://docwiki.embarcadero.com/RADStudio/Sydney/j/index.php?title=RAD_サーバー_エッジモジュール&oldid=248114」から取得