ライセンスのデプロイ情報を取得する

  • [アーティクル]

Office および Dynamics ライセンスの展開情報を取得する方法。

前提条件

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

REST 要求

要求の構文

認証方法 要求 URI
GET {baseURL}/v1/analytics/commercial/deployment/license/ HTTP/1.1

要求ヘッダー

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

URI パラメーター

パラメーター Type 説明 必須
top string 要求で返すデータの行数です。 最大値および指定しない場合の既定値は 10000 です。 クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。 いいえ
skip int クエリでスキップする行数です。 大きなデータ セットを操作するには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 を指定すると、データの最初の 10,000 行が取得され、top=10000 と skip=10000 を指定すると、データの次の 10,000 行が取得されます。 いいえ
filter string 要求の filter パラメーターには、応答内の行をフィルター処理する 1 つまたは複数のステートメントが含まれます。 各ステートメントには、 または ne 演算子に関連付eqけられているフィールドと値が含まれており、 ステートメントは または orを使用してand組み合わせることができます。 filter パラメーターの例を次に示します。

filter=serviceCode eq 'O365'
filter=serviceCode eq 'O365' または (channel eq 'Reseller')

次のフィールドを指定できます。

serviceCode
Servicename
チャネル
customerTenantId
customerName
productId
productName		 No
groupby string 指定したフィールドのみにデータ集計を適用するステートメントです。 次のフィールドを指定できます。

serviceCode
Servicename
チャネル
customerTenantId
customerName
productId
productName

返されるデータ行には、 groupby パラメーターで指定されたフィールドと次のものが含まれます。

licensesDeployed
licensesSold		 いいえ
processedDateTime DateTime 使用状況データの処理元の日付を指定できます。 既定値は、データが処理された最新の日付です いいえ

要求の例

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/commercial/deployment/license?filter=customerTenantId%20eq%20%270112A436-B14E-4888-967B-CA4BB2CF1234%27 HTTP 1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: bad5f75f-fd44-43ab-9325-bbc79dcba9da
MS-CorrelationId: 9cbdf63c-2608-4ad8-b0a9-abae27d859d9
X-Locale: en-US
Host: api.partnercenter.microsoft.com

REST 応答

成功した場合、応答本文には、デプロイされたライセンスに関するデータを含む次のフィールドが含まれます。

フィールド Type 説明
serviceCode string サービス コード
serviceName string [サービス名]
channel string チャネル名、リセラー
customerTenantId string 顧客の一意識別子
customerName string 顧客名
productId string 製品の一意識別子
productName string 製品名
licensesDeployed long デプロイされたライセンスの数
licensesSold long 販売済みライセンス数
processedDateTime DateTime データが最後に処理された日付

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

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

応答の例

HTTP/1.1 200 OK
Content-Length: 487
Content-Type: application/json; charset=utf-8
MS-CorrelationId: 9cbdf63c-2608-4ad8-b0a9-abae27d859d9
MS-RequestId: bad5f75f-fd44-43ab-9325-bbc79dcba9da
MS-CV: f0trvmq8mEScHcFS.0
MS-ServerId: 4
Date: Wed, 24 Oct 2018 22:37:18 GMT
{
  "Value": [

{
      "processedDateTime": "2018-10-14T00:00:00",
      "serviceCode": "crm",
      "serviceName": "Microsoft Dynamics",
      "channel": "reseller",
      "customerTenantId": "0112A436-B14E-4888-967B-CA4BB2CF1234",
      "customerName": "TEST COMPANY",
      "productId": "54B84594-9C77-4499-8D65-5E0D5F410E78",
      "productName": "DYNAMICS AX TASK",
      "licensesDeployed": 0,
      "licensesSold": 9
    },
    {
      "processedDateTime": "2018-10-14T00:00:00",
      "serviceCode": "o365",
      "serviceName": "Microsoft Office 365",
      "channel": "reseller",
      "customerTenantId": "0112A436-B14E-4888-967B-CA4BB2CF1234",
      "customerName": "TEST COMPANY",
      "productId": "D3B4FE1F-9992-4930-8ACB-CA6EC609365E",
      "productName": "DOMESTIC AND INTERNATIONAL CALLING PLAN",
      "licensesDeployed": 0,
      "licensesSold": 5
    }
],
  "@nextLink": null,
  "TotalCount": 2
}