次の方法で共有

デバイス コマンドの状態を取得する (非推奨)

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

デバイス上のコマンドの状態を取得します。 状態コードの完全な一覧については、「 actionStatus の一覧」を参照してください。

注意

この API は非推奨であり、2020 年 9 月 30 日にデータの返しを停止しました。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) サポートされていません。 サポートされていません。
委任 (個人用 Microsoft アカウント) Device.Command 注意事項なし。
アプリケーション サポートされていません。 サポートされていません。

HTTP 要求

GET me/devices/{id}/commands/{id}

要求ヘッダー

ヘッダー 値
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
承諾 application/json

応答

HTTP/1.1 200 OK

  {
    "id": "0",
    "status": "requesting",
    "type": "null",
    "appServiceName": "null",
    "packageFamilyName": "null",
    "error": "null",
    "responsepayload": "null",
    "payload": "null",
    "permissionTicket": "null",
    "postBackUri": "null"
  }

actionStatus の一覧

  • 要求中、// コマンドが作成され、処理を待機しています
  • sentToTarget、// コマンドがターゲット デバイスに送信されました
  • 実行中、// ターゲット デバイスはコマンドの受信を確認し、それを実行しています
  • 完了、 // コマンドの実行が完了しました
  • failedToSend、// サービスがターゲット デバイスにコマンドを送信できませんでした
  • executionFailed、// コマンドの実行に失敗しました
  • commandDropped、// デバイスが ConnectedStandby 状態の場合にクライアントによって削除されたコマンド
  • cancel、// コマンドを取り消す
  • 取り消し、// コマンドの取り消し
  • 取り消されました。// コマンドが取り消されました
  • retry、 // Service がターゲットにコマンドを送信することを再試行しています
  • 有効期限切れ、// コマンド処理が有効期限を超えました
  • error, // コマンド処理中の内部エラー
  • custom // Custom status

例

この例では、デバイスの ID と、デバイスに発行されたコマンドの ID が必要です。 に対する GET 呼び出しを発行するとデバイス ID が返され、 で /me/devices/{id}/commandPOST 呼び出し/me/devicesを実行するとコマンド ID が返されます。

要求

次の例は要求を示しています。

GET me/devices/{id}/commands/{id}
Authorization: Bearer Eaeou....
Content-Type: application/json; charset=utf-8

応答

次の例は応答を示しています。

HTTP/1.1 200 OK

{
  "value":
  {
    "id": "0158355AD4D680CC4E2994CC009EFFD7337D1335FCA6ED266…",
    "status": "completed",
    "type": null,
    "appServiceName": null,
    "packageFamilyName": null,
    "error": null,
    "permissionTicket": null,
    "postBackUri": null,
    "payload": null
  }
}

コマンド ペイロードを取得する

デバイス上の特定のアクションの応答ペイロードを取得します。 応答ペイロードは、アプリ サービスにクエリを実行してデータを戻すときに使用されます。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) サポートされていません。
委任 (個人用 Microsoft アカウント) Device.Command
アプリケーション サポートされていません。

HTTP 要求

GET me/devices/{id}/commands/{id}/responsePayload

要求ヘッダー

ヘッダー 値
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
承諾 application/json

応答

HTTP/1.1 200 OK

{
  "@odata.context": "https://graph.microsoft.com/devices/$metadata#microsoft.graph.PayloadResponse",
  "MsIgnoredParameter":0,
  "CreationDate":"date-time",
  "Type":"Ok"
}

例

この例では、デバイスの ID と、デバイスに発行されたコマンドの ID が必要です。 で GET 呼び出しを発行するとデバイス ID が返され、 で /me/devicesPOST 呼び出 /me/devices/{id}/commandしを実行するとコマンド ID が返されます。

要求

次の例は要求を示しています。

GET me/devices/{id}/commands/{id}
Authorization: Bearer Eaeou....
Content-Type: application/json; charset=utf-8

応答

次の例は応答を示しています。

HTTP/1.1 200 OK

{
  "@odata.context": "https://graph.microsoft.com/devices/$metadata#microsoft.graph.PayloadResponse",
  "MsIgnoredParameter":0,
  "CreationDate":"04/27/2017",
  "Type":"Ok"
}