次の方法で共有

デバイスのバッチ アップロードの状態を取得する

  • [アーティクル]

適用対象: パートナー センター

指定した顧客のデバイス バッチ アップロードの状態を取得する方法。

対象ロール: 管理エージェント | 販売エージェント

前提条件

  • パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、スタンドアロン アプリとアプリ + ユーザーの両方の資格情報を使った認証がサポートされています。

  • 顧客 ID です (customer-tenant-id)。 顧客の ID がわからない場合は、パートナー センターで [顧客] ワークスペースを選び、顧客一覧から顧客を選び、[アカウント] を選んで調べることができます。 お客様のアカウント ページで、[顧客のアカウント情報] セクションの Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。

  • デバイス バッチが送信されたときに Location ヘッダーで返されるバッチ追跡識別子。 詳細については、「 指定した顧客のデバイスの一覧をアップロードするを参照してください。

C#

デバイス バッチ アップロードの状態を取得するには、まず、顧客 ID を指定して IAggregatePartner.Customers.ById メソッドを呼び出して、指定した顧客に対する操作へのインターフェイスを取得します。 次に、バッチ追跡 ID を指定して BatchUploadStatus.ById メソッドを呼び出して、バッチ アップロード状態操作のインターフェイスを取得します。 最後に、 Get または GetAsync メソッドを呼び出して状態を取得します。

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

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

サンプル: Console テスト アプリ。 プロジェクト: パートナー センター SDK サンプル Class: GetBatchUploadStatus.cs

REST 要求

要求の構文

認証方法 要求 URI
GET {baseURL}/v1/customers/{customer-id}/batchJobStatus/{batchtracking-id} HTTP/1.1

URI パラメーター

要求を作成するときは、次のパス パラメーターを使用します。

名前 タイプ Required 説明
customer-id string はい 顧客を識別する GUID 形式の文字列。
batchtracking-id string はい デバイス バッチ アップロードの状態を取得するために使用される GUID 形式の識別子。 デバイス バッチが正常に送信されると、この ID が Location ヘッダーに返されます。

要求ヘッダー

詳細については、「パートナー センター REST ヘッダー」を参照してください。

要求本文

なし

要求の例

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

REST 応答

成功した場合、応答には BatchUploadDetails リソースが含まれます。

応答の成功とエラーのコード

各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。 このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。 完全な一覧については、パートナー センターの REST エラーコードに関する記事を参照してください。

応答の例

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