Obter o status de um upload em lote de dispositivoGet the status of a device batch upload

Aplica-se aApplies To

  • Partner CenterPartner Center
  • Partner Center do Microsoft Cloud GermanyPartner Center for Microsoft Cloud Germany

Como obter o status de um carregamento em lote de dispositivo para um cliente especificado.How to get the status of a device batch upload for a specified customer.

Pré-requisitosPrerequisites

  • Credenciais, conforme descrito em Autenticação do Partner Center.Credentials as described in Partner Center authentication. Esse cenário dá suporte à autenticação com aplicativos autônomos e aplicativos + credenciais de usuário.This scenario supports authentication with both standalone App and App+User credentials.

  • Uma ID do cliente (customer-tenant-id).A customer ID (customer-tenant-id). Se você não souber a ID do cliente, poderá procurar no painel do Partner Center.If you don't know the customer's ID, you can look it up in the Partner Center dashboard. Selecione CSP no menu do Partner Center e, em seguida, Clientes.Select CSP from the Partner Center menu, followed by Customers. Selecione o cliente na lista de clientes e selecione Conta.Select the customer from the customer list, then select Account. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente.On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. A ID da Microsoft é igual à ID do cliente (customer-tenant-id).The Microsoft ID is the same as the customer ID (customer-tenant-id).

  • O identificador de rastreamento do lote retornado no cabeçalho de local quando o lote do dispositivo foi enviado.The batch tracking identifier returned in the Location header when the device batch was submitted. Para obter mais informações, consulte carregar uma lista de dispositivos para o cliente especificado.For more information, see Upload a list of devices for the specified customer.

C#C#

Para obter o status de um carregamento em lote de dispositivo, primeiro chame o método IAggregatePartner. Customers. ById com a ID Customer para recuperar uma interface para operações no cliente especificado.To get the status of a device batch upload, first call the IAggregatePartner.Customers.ById method with the customer ID to retrieve an interface to operations on the specified customer. Em seguida, chame o método BatchUploadStatus. ById com a ID de rastreamento do lote para obter uma interface para operações de status de carregamento em lote.Then, call the BatchUploadStatus.ById method with the batch tracking ID to get an interface to batch upload status operations. Por fim, chame o método Get ou getasync para recuperar o status.Finally, call the Get or GetAsync method to retrieve the status.

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

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

Exemplo: aplicativo de teste do console.Sample: Console test app. Projeto: classede exemplos do SDK do Partner Center: GetBatchUploadStatus.csProject: Partner Center SDK Samples Class: GetBatchUploadStatus.cs

Solicitação RESTREST request

Sintaxe da solicitaçãoRequest syntax

MétodoMethod URI da solicitaçãoRequest URI
GETGET {baseURL}/v1/Customers/{Customer-ID}/batchJobStatus/{batchtracking-ID} http/1.1{baseURL}/v1/customers/{customer-id}/batchJobStatus/{batchtracking-id} HTTP/1.1

Parâmetro do URIURI parameter

Use os seguintes parâmetros de caminho ao criar a solicitação.Use the following path parameters when creating the request.

NomeName TipoType ObrigatórioRequired DescriçãoDescription
id do clientecustomer-id stringstring SimYes Uma cadeia com formato de GUID que identifica o cliente.A GUID-formatted string that identifies the customer.
batchtracking-IDbatchtracking-id stringstring SimYes Um identificador formatado por GUID que é usado para recuperar um status de carregamento de lote de dispositivo.A GUID-formatted identifier that is used to retrieve a device batch upload status. Essa ID é retornada no cabeçalho Location quando o lote do dispositivo é enviado com êxito.This ID is returned in the Location header when the device batch is successfully submitted.

Cabeçalhos de solicitaçãoRequest headers

Para obter mais informações, confira Cabeçalhos REST do Partner Center.For more information, see Partner Center REST headers.

Corpo da solicitaçãoRequest body

NenhumNone

Exemplo de solicitaçãoRequest example

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: de894e18-f027-4ac0-8b5a-34f0c222af0c
X-Locale: en-US
Host: api.partnercenter.microsoft.com

Resposta RESTREST response

Se for bem-sucedida, a resposta conterá um recurso BatchUploadDetails .If successful, the response contains a BatchUploadDetails resource.

Códigos de êxito e de erro de respostaResponse success and error codes

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais.Use a network trace tool to read this code, error type, and additional parameters. Para obter a lista completa, confira Códigos de erro REST do Partner Center.For the full list, see Partner Center REST error codes.

Exemplo de respostaResponse example

HTTP/1.1 200 OK
Content-Length: 400
MS-CorrelationId: 4a5002a2-0c1b-4e57-b491-dbcf19c0e7b8
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"
    }
}