ServiceDiscovery - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

DeviceConnectシステム上のサービス検索機能を提供するAPI。

API	概要
GET /gotapi/serviceDiscovery	DeviceConnectサービスの検索を行う。
PUT /gotapi/serviceDiscovery/onServiceChange	DeviceConnectサービス一覧の変更通知を受領する。
DELETE /gotapi/serviceDiscovery/onServiceChange	DeviceConnectサービス一覧の変更通知イベントを停止する。

one-shot

DeviceConnectサービスの検索を行う。

DeviceConnectサービス検索機能を提供するAPI。
取得できる情報としては、サービスID、サービス名、ネットワーク種別、 利用可能状態やデバイス固有のコンフィグ情報がある。

物理名	データ型	必須	説明

論理名		物理名	データ型	必須	説明
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
サービス一覧		services	array(object)	Yes	DeviceConnectサービスの配列。
	サービスID	id	string	Yes	サービスを識別するためのID。
	サービス名	name	string	Yes	サービスの名前。
	ネットワーク種別	type	string	No	ホストデバイスと接続するためのネットワークの種別。
	利用可能状態	online	boolean	Yes	サービスが利用可能であるかどうかを示すフラグ。
	コンフィグ	config	string	No	サービス固有の設定がある場合には、ここに文字列として格納される。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "services" : [ {
    "id" : "example-service-id",
    "name" : "Example Service",
    "online" : true
  } ]
}

event

DeviceConnectサービス一覧の変更通知を受領する。

DeviceConnectサービスの追加・削除・利用可能状態変更を通知するためのイベント。

物理名	データ型	必須	説明

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

論理名			物理名	データ型	必須	説明
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
オブジェクト			networkService	object	Yes	イベントの内容を保持するオブジェクト。
	サービス一覧		services	array(object)	Yes	DeviceConnectサービスの配列。
		サービスID	id	string	Yes	サービスを識別するためのID。
		サービス名	name	string	Yes	サービスの名前。
		ネットワーク種別	type	string	No	ホストデバイスと接続するためのネットワークの種別。
		利用可能状態	online	boolean	Yes	サービスが利用可能であるかどうかを示すフラグ。
		コンフィグ	config	string	No	サービス固有の設定がある場合には、ここに文字列として格納される。

{
  "profile" : "serviceDiscovery",
  "attribute" : "onServiceChange",
  "networkService" : {
    "services" : [ {
      "id" : "example-service-id",
      "name" : "Example Service",
      "online" : true
    } ]
  }
}

event

DeviceConnectサービス一覧の変更通知イベントを停止する。

DeviceConnectサービスの追加・削除・利用可能状態変更を通知するためのイベント。

物理名	データ型	必須	説明

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}