Obter uma lista de dispositivos para o lote e o cliente especificados

Artigo
03/06/2024

Aplica-se a: Partner Center

Este artigo descreve como recuperar uma coleção de dispositivos em um lote de dispositivo especificado para um cliente especificado. Cada recurso de dispositivo contém detalhes sobre o dispositivo.

Pré-requisitos

Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário dá suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.
Uma ID do cliente (customer-tenant-id). Se você não souber a ID do cliente, poderá pesquisá-la no Partner Center selecionando o workspace 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 é igual à ID do cliente (customer-tenant-id).
Um identificador de lote do dispositivo.

C#

Para recuperar uma coleção dos dispositivos em um lote de dispositivo especificado para o cliente especificado:

Chame o método IAggregatePartner.Customers.ById com a ID do cliente para recuperar uma interface para operações no cliente especificado.
Chame o método DeviceBatches.ById para obter uma interface para operações de coleta em lote do dispositivo para o lote especificado.
Recupere a propriedade Devices para obter uma interface para operações de coleta de dispositivos para o lote.
Chame o método Get ou GetAsync para recuperar a coleção de dispositivos.

IAggregatePartner partnerOperations;
string selectedCustomerId;
string selectedDeviceBatchId;

var devices =
    partnerOperations.Customers.ById(selectedCustomerId).DeviceBatches.ById(selectedDeviceBatchId).Devices.Get();

Para obter um exemplo, consulte o seguinte:

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

Solicitação REST

Sintaxe da solicitação

Método	URI da solicitação
GET	{baseURL}/v1/customers/{customer-id}/deviceBatches/{devicebatch-id}/devices HTTP/1.1

Parâmetros do URI

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

Nome	Type	Obrigatório	Descrição
id do cliente	string	Sim	Uma cadeia com formato de GUID que identifica o cliente.
devicebatch-id	string	Sim	Um identificador de cadeia de caracteres que identifica o lote do dispositivo.

Cabeçalhos de solicitação

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

Corpo da solicitação

Nenhum

Exemplo de solicitação

GET https://api.partnercenter.microsoft.com/v1/customers/47021739-3426-40bf-9601-61b4b6d7c793/deviceBatches/testbatch/devices 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 REST

Se tiver êxito, o corpo da resposta conterá uma coleção paginada de Recursos do dispositivo . A coleção contém 100 dispositivos em uma página. Para recuperar a próxima página de 100 dispositivos, o continuationToken no corpo da resposta deve ser incluído na solicitação subsequente como um cabeçalho MS-ContinuationToken.

Códigos de êxito e de erro de resposta

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

Exemplo de resposta

HTTP/1.1 200 OK
Content-Length: 1742
Content-Type: application/json; charset=utf-8
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

{
    "totalCount": 2,
    "items":
    [{
            "id": "7c141ea9-2816-4e15-a819-53f6856499ff",
            "serialNumber": "2R9-ZNP67",
            "productKey": "00329-00000-0003-AA6069",
            "modelName": "Precision WorkStation T7500",
            "oemManufacturerName":"Dell Inc.",
            "policies":[{
                    "key": "o_o_b_e",
                    "value": null
                }
            ],
            "uploadedDate":"2017-08-09T14:43:26.0092288-07:00",
            " attributes": {
                "objectType": "Device"
            }
        }, {
            "id": "e528a62f-5031-49f4-bea7-5fafe47388fd",
            "serialNumber": "1234567890",
            "productKey": "12345-67890-09876-54321-13579",
            "modelName": "HP Z420 Workstation",
            "oemManufacturerName": "Hewlett-Packard",
            "policies": [{
                    "key": "o_o_b_e",
                    "value": null
                }
            ],
            "uploadedDate": "2017-08-09T14:35:51.3126144-07:00",
            "attributes": {
                "objectType": "Device"
            }
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}

Share via