Pobieranie stanu przekazywania wsadowego urządzeń
Dotyczy: Centrum partnerskie
Jak uzyskać stan przekazywania wsadowego urządzenia dla określonego klienta.
Odpowiednie role: administrator globalny | Agent administracyjny | Agent sprzedaży
Wymagania wstępne
Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje uwierzytelnianie zarówno przy użyciu autonomicznych poświadczeń aplikacji, jak i aplikacji i użytkownika.
Identyfikator klienta (
customer-tenant-id
). Jeśli nie znasz identyfikatora klienta, możesz wyszukać go w Centrum partnerskim, wybierając obszar roboczy Klienci , a następnie klienta z listy klienta, a następnie pozycję Konto. Na stronie Konto klienta poszukaj identyfikatora Microsoft w sekcji Informacje o koncie klienta. Identyfikator Microsoft jest taki sam jak identyfikator klienta (customer-tenant-id
).Identyfikator śledzenia wsadowego zwrócony w nagłówku Lokalizacja po przesłaniu partii urządzenia. Aby uzyskać więcej informacji, zobacz Przekazywanie listy urządzeń dla określonego klienta.
C#
Aby uzyskać stan przekazywania wsadowego urządzenia, najpierw wywołaj metodę IAggregatePartner.Customers.ById z identyfikatorem klienta, aby pobrać interfejs do operacji na określonym kliencie. Następnie wywołaj metodę BatchUploadStatus.ById przy użyciu identyfikatora śledzenia wsadowego, aby uzyskać interfejs operacji stanu przekazywania wsadowego. Na koniec wywołaj metodę Get lub GetAsync, aby pobrać stan.
// IAggregatePartner partnerOperations;
// string selectedCustomerId;
// string selectedTrackingId;
var status =
partnerOperations.Customers.ById(selectedCustomerId).BatchUploadStatus.ById(selectedTrackingId).Get();
Przykład: aplikacja testowa konsoli. Projekt: Klasa przykładów zestawu SDK Centrum partnerskiego: GetBatchUploadStatus.cs
Żądanie REST
Składnia żądania
Metoda | Identyfikator URI żądania |
---|---|
GET | {baseURL}/v1/customers/{customer-id}/batchJobStatus/{batchtracking-id} HTTP/1.1 |
Parametr identyfikatora URI
Podczas tworzenia żądania użyj następujących parametrów ścieżki.
Imię i nazwisko | Typ | Wymagana | Opis |
---|---|---|---|
identyfikator klienta | ciąg | Tak | Ciąg sformatowany za pomocą identyfikatora GUID, który identyfikuje klienta. |
batchtracking-id | ciąg | Tak | Identyfikator w formacie GUID używany do pobierania stanu przekazywania wsadowego urządzenia. Ten identyfikator jest zwracany w nagłówku Lokalizacja po pomyślnym przesłaniu partii urządzenia. |
Nagłówki żądań
Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.
Treść żądania
Brak
Przykład żądania
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
Odpowiedź REST
W przypadku powodzenia odpowiedź zawiera zasób BatchUploadDetails .
Kody powodzenia i błędów odpowiedzi
Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i dodatkowe informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i dodatkowe parametry. Aby uzyskać pełną listę, zobacz Kody błędów REST Centrum partnerskiego.
Przykład odpowiedzi
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"
}
}