action.devices.QUERY

このインテントは、デバイスがオンラインかどうか、到達可能かどうかなど、デバイスの現在の状態をフルフィルメントに照会します。

QUERY レスポンスは状態情報のみを返す必要があります。デバイスの属性とトレイトの更新は、 SYNC レスポンス。

詳細については、クエリと実行をご覧ください。

リクエストの形式

フィールド	タイプ	説明
`requestId`	String	必須。リクエストの ID。
`inputs`	配列	必須。インテントリクエストに一致する入力のリスト。
`[item, ...]`	オブジェクト	インテントリクエストに関連付けられているタイプとペイロード。
`intent`		必須。（定数値: `"action.devices.QUERY"`）インテントのリクエストタイプ。
`payload`	オブジェクト	必須。 QUERY リクエストのペイロード。
`devices`	配列	必須。対象デバイスのリスト。
`[item, ...]`	オブジェクト	クエリするデバイスターゲット。
`id`	String	必須。 SYNC で提供される ID に基づくデバイス ID。
`customData`	オブジェクト	不透明な customData オブジェクトが SYNC で提供される場合は、ここで送信されます。

例

QUERY インテントリクエスト

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123",
            "customData": {
              "fooValue": 74,
              "barValue": true,
              "bazValue": "foo"
            }
          },
          {
            "id": "456",
            "customData": {
              "fooValue": 12,
              "barValue": false,
              "bazValue": "bar"
            }
          }
        ]
      }
    }
  ]
}

レスポンスの形式

フィールド	タイプ	説明
`requestId`	String	必須。対応するリクエストの ID。
`payload`	オブジェクト	必須。インテントレスポンスペイロード。
`errorCode`	String	認証の失敗やデベロッパーシステムが利用できなくなった場合のトランザクション全体のエラーコード。個々のデバイスのエラーには、デバイスオブジェクト内の errorCode を使用します。
`debugString`	String	エラーの詳細。ユーザーには表示されませんが、開発中にログに記録または使用される可能性があります。
`devices`	オブジェクト	必須。デバイスのマップ。デベロッパーデバイス ID を状態プロパティのオブジェクトにマッピングします。
`<string>`	オブジェクト	デバイスの状態。
`online`	ブール値	必須。デバイスがオンライン（つまり到達可能）かどうかを示します。
`status`	String	必須。クエリオペレーションの結果。サポートされている値: `SUCCESS` クエリが成功したことを確認します。 `OFFLINE` ターゲットデバイスがオフライン状態であるか、到達できません。 `EXCEPTIONS` クエリに関連する問題またはアラートがあります。クエリは成功することも失敗することもあります。通常、このステータスタイプは、接続されている別のデバイスに関する追加情報を送信する場合に設定されます。 `ERROR` 対象デバイスをクエリできません。
`errorCode`	String	ERROR 状態を、必要に応じて、プリセットのエラーコードから拡張します。ユーザーに表示されるエラーに対応付けられます。

例

QUERY インテントのレスポンス

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "devices": {
      "123": {
        "on": true,
        "online": true,
        "status": "SUCCESS"
      },
      "456": {
        "on": true,
        "online": true,
        "status": "SUCCESS",
        "brightness": 80,
        "color": {
          "spectrumRgb": 16711935
        }
      }
    }
  }
}