Obtenir l’état d’un chargement de lot d’appareils

Article
09/11/2024

S’applique à : Espace partenaires

Comment obtenir l’état d’un chargement par lot d’appareils pour un client spécifié.

Rôles appropriés : Agent d’administration | Commercial

Prérequis

Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario prend en charge l’authentification avec les informations d’identification d’application et d’application+utilisateur autonomes.
ID du client (customer-tenant-id). Si vous ne connaissez pas l’ID du client, vous pouvez le rechercher dans l’Espace de partenaires en sélectionnant l’espace de travail Clients, puis le client dans la liste des clients, puis compte. Dans la page du compte du client, recherchez l’ID Microsoft dans la section Informations sur le compte client. L’ID Microsoft est le même que l’ID de client (customer-tenant-id).
Identificateur de suivi par lots retourné dans l’en-tête Emplacement lorsque le lot d’appareils a été envoyé. Pour plus d’informations, consultez Charger une liste d’appareils pour le client spécifié.

C#

Pour obtenir l’état d’un chargement par lots d’appareils, appelez d’abord la méthode IAggregatePartner.Customers.ById avec l’ID client pour récupérer une interface aux opérations sur le client spécifié. Ensuite, appelez la méthode BatchUploadStatus.ById avec l’ID de suivi par lots pour obtenir une interface pour effectuer des opérations d’état de chargement par lots. Enfin, appelez la méthode Get ou GetAsync pour récupérer l’état.

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

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

Exemple : Application de test de console. Projet : Classe d’exemples sdk de l’Espace partenaires : GetBatchUploadStatus.cs

Demande REST

Syntaxe de la requête

Method	URI de demande
GET	{baseURL}/v1/customers/{customer-id}/batchJobStatus/{batchtracking-id} HTTP/1.1

Paramètre d’URI

Utilisez les paramètres de chemin d’accès suivants lors de la création de la requête.

Nom	Type	Requise	Description
id-client	string	Oui	Chaîne au format GUID qui identifie le client.
batchtracking-id	string	Oui	Identificateur au format GUID utilisé pour récupérer l’état de chargement d’un lot d’appareils. Cet ID est retourné dans l’en-tête Location lorsque le lot d’appareils est envoyé avec succès.

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.

Corps de demande

Aucune

Exemple de requête

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

Réponse REST

Si elle réussit, la réponse contient une ressource BatchUploadDetails .

Codes d’erreur et de réussite de la réponse

Chaque réponse est accompagnée d’un code d’état HTTP qui indique la réussite ou l’échec ainsi que des informations de débogage supplémentaires. Utilisez un outil de trace réseau pour lire ce code, le type d’erreur et des paramètres supplémentaires. Pour obtenir la liste complète, consultez Codes d’erreur REST de l’Espace partenaires.

Exemple de réponse

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

Partager via