Obter status de comando do dispositivo (preterido)

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor de versão.

Obter o status de um comando em um dispositivo. Para ver a lista completa de códigos de status, consulte Lista de actionStatus.

Cuidado

Essa API foi preterida e parou de retornar dados em 30 de setembro de 2020.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante) Sem suporte.
Delegado (conta pessoal da Microsoft) Device.Command
Aplicativo Sem suporte.

Solicitação HTTP

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

Cabeçalhos de solicitação

Cabeçalho Valor
Autorização {token} de portador. Obrigatório.
Aceitar application/json

Resposta

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

Lista de actionStatus

  • solicitando, // O comando foi criado e está aguardando para ser processado
  • sentToTarget, // Command foi enviado para o dispositivo de destino
  • executing, // Target device acknowledged receipt of the command and is executing it
  • concluída, // Execução de comando concluída
  • failedToSend, // Service failed to send command to target device
  • executionFailed, // Falha na execução do comando
  • commandDropped, // Command dropped by client if device is in ConnectedStandby state
  • cancel, // Cancel the command
  • cancelando, // Cancelando o comando
  • cancelado, // Command foi cancelado
  • repetir, // O serviço está tentando novamente enviar o comando para o destino
  • expirado, // Processamento de comando excedeu o tempo de expiração
  • erro, // Erro interno durante o processamento do comando
  • status personalizado // Personalizado

Exemplo

Neste exemplo, você precisará da ID do dispositivo e da ID do comando que foi emitido para um dispositivo. A ID do dispositivo é retornada ao emissão de uma chamada GET para , e a ID de comando é retornada ao fazer uma /me/devices chamada POST em /me/devices/{id}/command .

Solicitação

O exemplo a seguir mostra a solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 200 OK

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

Obter carga de comando

Obter uma carga de resposta para uma ação específica em um dispositivo. A carga de resposta é usada ao consultar um serviço de aplicativo para carregar dados de volta.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante) Sem suporte.
Delegado (conta pessoal da Microsoft) Device.Command
Aplicativo Sem suporte.

Solicitação HTTP

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

Cabeçalhos de solicitação

Cabeçalho Valor
Autorização {token} de portador. Obrigatório.
Aceitar application/json

Resposta

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

Exemplo

Neste exemplo, você precisará da ID do dispositivo e da ID do comando que foi emitido para um dispositivo. A ID do dispositivo é retornada quando uma chamada GET é em emissão e a ID do comando é retornada ao fazer uma /me/devices chamada POST em /me/devices/{id}/command .

Solicitação

O exemplo a seguir mostra a solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 200 OK

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