デバイス コマンドの状態を取得する (非推奨)
名前空間: microsoft.graph
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
デバイス上のコマンドの状態を取得します。 状態コードの完全な一覧については 、「ActionStatus の一覧」を参照してください。
注意事項
この API は廃止され、2020 年 9 月 30 日にデータの返しが停止されました。
アクセス許可
この 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 の一覧
- 要求中、// Command が作成され、処理を待機している
- sentToTarget、// Command がターゲット デバイスに送信されました
- 実行中、// ターゲット デバイスがコマンドの受信を確認し、実行中
- 完了、// コマンドの実行が完了しました
- failedToSend、 // Service がターゲット デバイスにコマンドを送信できなかった
- executionFailed、// Command の実行に失敗しました
- commandDropped、 // デバイスが ConnectedStandby 状態の場合にクライアントによってドロップされるコマンド
- cancel, // Cancel the command
- キャンセル、// コマンドの取り消し
- canceled, // Command が取り消されました
- 再試行、// サービスがターゲットにコマンドを送信する再試行中
- 期限切れ、// コマンド処理が有効期限を超えた
- error、 // コマンドの処理中の内部エラー
- custom // Custom status
例
この例では、デバイスの ID と、デバイスに発行されたコマンドの ID が必要です。 GET 呼び出しを発行するときにデバイス ID が返され、POST 呼び出しを実行するときにコマンド /me/devices ID が返されます /me/devices/{id}/command 。
要求
次の例は要求を示しています。
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 が返され、POST 呼び出しを実行するときにコマンド /me/devices ID が返されます /me/devices/{id}/command 。
要求
次の例は要求を示しています。
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"
}
フィードバック
フィードバックの送信と表示