Partager via

Obtenir la status de commande de l’appareil (déconseillé)

  • Article

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Obtenez le status d’une commande sur un appareil. Pour obtenir la liste complète des codes status, consultez Liste d’actionStatus.

Attention

Cette API est déconseillée et a cessé de retourner des données le 30 septembre 2020.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Non prise en charge. Non prise en charge.
Déléguée (compte Microsoft personnel) Device.Command Non disponible.
Application Non prise en charge. Non prise en charge.

Requête HTTP

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

En-têtes de demande

En-tête Valeur
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Accepter application/json

Réponse

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"
  }

Liste d’actionStatus

  • demande, // La commande a été créée et attend d’être traitée
  • sentToTarget, // La commande a été envoyée à l’appareil cible
  • en cours d’exécution, // L’appareil cible a accusé réception de la commande et l’exécute
  • terminé, // Exécution de la commande terminée
  • failedToSend, // Le service n’a pas pu envoyer la commande à l’appareil cible
  • executionFailed, // L’exécution de la commande a échoué
  • commandDropped, // Commande supprimée par le client si l’appareil est à l’état ConnectedStandby
  • cancel, // Annuler la commande
  • cancelling, // Annulation de la commande
  • canceled, // Command has been cancelled
  • retry, // Service effectue une nouvelle tentative pour envoyer la commande à la cible
  • expiré, // Le traitement des commandes a dépassé le délai d’expiration
  • error, // Erreur interne lors du traitement de la commande
  • custom // Custom status

Exemple

Dans cet exemple, vous avez besoin de l’ID de l’appareil et de l’ID de la commande qui a été émise à l’appareil. L’ID d’appareil est retourné lors de l’émission d’un appel GET à /me/devices, et l’ID de commande est retourné lors d’un appel POST sur /me/devices/{id}/command.

Demande

L’exemple suivant illustre la demande.

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

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 200 OK

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

Obtenir la charge utile de commande

Obtenir une charge utile de réponse pour une action spécifique sur un appareil. La charge utile de réponse est utilisée lors de l’interrogation d’un service d’application pour renvoyer des données.

Autorisations

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Type d’autorisation Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
Déléguée (compte professionnel ou scolaire) Non prise en charge.
Déléguée (compte Microsoft personnel) Device.Command
Application Non prise en charge.

Requête HTTP

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

En-têtes de demande

En-tête Valeur
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Accepter application/json

Réponse

HTTP/1.1 200 OK

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

Exemple

Dans cet exemple, vous avez besoin de l’ID de l’appareil et de l’ID de la commande qui a été émise à l’appareil. L’ID d’appareil est retourné lors de l’émission d’un appel GET sur /me/devices, et l’ID de commande est retourné lors d’un appel POST sur /me/devices/{id}/command.

Demande

L’exemple suivant illustre la demande.

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

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 200 OK

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