Obter o estado de um carregamento de lotes de dispositivos

Artigo
10/15/2024

Aplica-se a: Partner Center

Como obter o status de um carregamento de lote de dispositivo para um cliente especificado.

Funções apropriadas: Agente administrativo | Agente de vendas

Pré-requisitos

Credenciais conforme descrito na autenticação do Partner Center. Este cenário oferece suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.
Um ID de cliente (customer-tenant-id). Se não souber o ID do cliente, pode procurá-lo no Partner Center selecionando a área de trabalho Clientes e, em seguida, o cliente na lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente. A ID da Microsoft é a mesma que a ID do cliente (customer-tenant-id).
O identificador de rastreamento de lote retornado no cabeçalho Location quando o lote de dispositivo foi enviado. Para obter mais informações, consulte Carregar uma lista de dispositivos para o cliente especificado.

C#

Para obter o status de um carregamento de lote de dispositivo, primeiro chame o método IAggregatePartner.Customers.ById com o ID do cliente para recuperar uma interface para operações no cliente especificado. Em seguida, chame o método BatchUploadStatus.ById com o ID de rastreamento de lote para obter uma interface para operações de status de carregamento em lote. Finalmente, chame o método Get ou GetAsync para recuperar o status.

// IAggregatePartner partnerOperations;
// string selectedCustomerId;
// string selectedTrackingId;

var status =
    partnerOperations.Customers.ById(selectedCustomerId).BatchUploadStatus.ById(selectedTrackingId).Get();

Exemplo: Aplicativo de teste de console. Projeto: Exemplos de SDK do Partner Center Classe: GetBatchUploadStatus.cs

Pedido REST

Sintaxe da solicitação

Método	URI do pedido
GET	{baseURL}/v1/customers/{customer-id}/batchJobStatus/{batchtracking-id} HTTP/1.1

Parâmetro URI

Use os seguintes parâmetros de caminho ao criar a solicitação.

Nome	Type	Obrigatório	Description
ID do cliente	string	Sim	Uma cadeia de caracteres formatada em GUID que identifica o cliente.
batchtracking-id	string	Sim	Um identificador formatado em GUID que é usado para recuperar o status de carregamento de um lote de dispositivo. Essa ID é retornada no cabeçalho Location quando o lote de dispositivo é enviado com êxito.

Cabeçalhos do pedido

Para obter mais informações, consulte Cabeçalhos REST do Partner Center.

Corpo do pedido

Nenhuma

Exemplo de solicitação

GET https://api.partnercenter.microsoft.com/v1/customers/47021739-3426-40bf-9601-61b4b6d7c793/batchjobstatus/0127ed8e-ff72-4983-a3d8-e8d8bd378932 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e88d014d-ab70-41de-90a0-f7fd1797267d
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Host: api.partnercenter.microsoft.com

Resposta do REST

Se bem-sucedida, a resposta contém um recurso BatchUploadDetails .

Códigos de sucesso e erro de resposta

Cada resposta vem com um código de status HTTP que indica sucesso ou falha e informações adicionais de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e parâmetros adicionais. Para obter a lista completa, consulte Códigos de erro REST do Partner Center.

Exemplo de resposta

HTTP/1.1 200 OK
Content-Length: 400
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: 7b3e2e00-b330-4480-9d84-59ace713427f
MS-CV: YrLe3w6BbUSMt1fi.0
MS-ServerId: 030020344
Date: Tue, 25 Jul 2017 17:52:41 GMT

{
    "batchTrackingId": "0127ed8e-ff72-4983-a3d8-e8d8bd378932",
    "status": "finished",
    "startedTime": "2017-07-25T10:00:00",
    "completedTime": "2017-07-25T10:10:00",
    "devicesStatus": [{
            "serialNumber": "1234567890",
            "productKey": "12345-67890-09876-54321-13579",
            "status": "finished_with_errors",
            "errorCode": "808",
            "errorDescription": "ZtdDeviceAssignedToOtherTenant",
            "attributes": {
                "objectType": "DeviceUploadDetails"
            }
        }
    ],
    "attributes": {
        "objectType": "BatchUploadDetails"
    }
}

Partilhar via