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 Versão.

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

Cuidado

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

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global	Governo dos EUA L4	GOVERNO DOS EUA L5 (DOD)	China operada pela 21Vianet
✅	❌	❌	❌

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão	Permissões menos privilegiadas	Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante)	Sem suporte.	Sem suporte.
Delegado (conta pessoal da Microsoft)	Device.Command	Indisponível.
Aplicativo	Sem suporte.	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. Saiba mais sobre autenticação e autorização.
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

• solicitação, // O comando foi criado e está aguardando para ser processado
• sentToTarget, // Command foi enviado para o dispositivo de destino
• executando, // Dispositivo de destino reconheceu o recebimento do comando e está executando-o
• concluída, // Execução de comando concluída
• falhaToSend, // O serviço falhou ao enviar o comando para o dispositivo de destino
• falha na execução de execução de // Falha na execução de comando
• commandDropped, // Command descartado pelo cliente se o dispositivo estiver no estado ConnectedStandby
• cancelar // Cancelar o comando
• cancelando// Cancelando o comando
• cancelado, // O comando foi cancelado
• repetindo, // O serviço está tentando novamente enviar o comando para o destino
• expirado, // O processamento de comando excedeu o tempo de expiração
• erro, // Erro interno durante o processamento do comando
• personalizado // Status personalizado

Exemplo

Neste exemplo, você precisa da ID do dispositivo e da ID do comando que foi emitido para o dispositivo. A ID do dispositivo é retornada ao emitir uma chamada GET para /me/devices, e a ID de comando é retornada ao fazer uma 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

Obtenha 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 levar os dados de volta.

Permissões

Uma das seguintes permissões é necessá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. Saiba mais sobre autenticação e autorização.
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ê precisa da ID do dispositivo e da ID do comando que foi emitido para o dispositivo. A ID do dispositivo é retornada ao emitir uma chamada GET em /me/devices, e a ID de comando é retornada ao fazer uma 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"
}