ライセンス・メトリックのしきい値とカスタム・フィールド値の設定 (v2)

権限

この API を使用するには、「コントラクトの管理」権限が必要です。

リソース URL

https://hostname:port/api/sam/v2/license_usage?token=token

リソース情報

スキーマの説明

GET api/sam/v2/schemas/license_usage.json?token=token

照会パラメーター

会話例 - ライセンス・メトリックのしきい値の設定

1. ライセンス・メトリックのしきい値を設定する製品の ID に関する情報を取得するには、以下の GET 要求を使用します。この要求は、製品の ID と名前、メトリック ID およびコード名を返します。

   要求

   GET api/sam/v2/license_usage?columns[]=product_id&columns[]=product_name
   &columns[]=metric_id&columns[]=metric_code_name&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623

   応答

   [{
   "product_id": 29258,
   "product_name": "WebSphere Service Registry and Repository",
   "metric_id": 3,
   "metric_code_name": "PVU_FULL_CAP"
   }]

2. ライセンス・メトリックのしきい値の値を変更するには、以下の PUT 要求を使用します。

   product_id パラメーターによって指定された製品と metric_id パラメーターによって指定されたライセンス・メトリックの関係は、ソフトウェア・カタログに存在している必要があります。存在しない場合、要求はエラーを返します。関係がソフトウェア・カタログに存在しない場合は、「Products & Metrics」パネルで関係を作成できます。詳しくは、下記を参照してください。製品への追加のメトリックの割り当て。

   要求

   PUT api/sam/v2/license_usage?product_id=29258&metric_id=3
   &threshold=300&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
   

   応答

   200 - OK

会話例 - カスタムフィールドの値の設定

1. 「すべてのメトリック」レポートで作成されたカスタム・フィールドのリストを確認するには、license_usage.json スキーマを表示します。このスキーマには、カスタム・フィールドを含むすべての列がリストされます。値を設定するカスタム・フィールドを識別します。

   要求 - 既存のカスタム・フィールドのリストの確認

   GET api/sam/v2/schemas/license_usage.json?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
   

   応答 - すべての列のリスト (カスタム・フィールドを含む)

   [{
   "product_name":
         {
          "type": "string",
          "description": "Name of the software product."
          },
   ...
   "custom_field_1":
          {
          "type": "boolean",
          "title": "Requires Extension"
          }
   }]

2. カスタム・フィールドの名前を識別したら、以下の PUT 要求を使用します。

   要求

   PUT api/sam/v2/license_usage?product_id=29258&metric_id=3&bundle_id=3496
   &custom_field_1=1&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
   

   応答

   200 - OK

会話例 - ライセンス・メトリックのしきい値のクリア

1. ライセンス・メトリックのしきい値をクリアする製品の ID に関する情報を取得するには、以下の GET 要求を使用します。この要求は、製品の ID と名前、メトリックの ID と名前、およびしきい値を返します。

   要求

   GET api/sam/v2/license_usage?columns[]=product_id&columns[]=product_name
   &columns[]=metric_id&columns[]=metric_name&columns[]=threshold
   &token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623

   応答

   [{
   "product_id": 29258,
   "product_name": "WebSphere Service Registry and Repository",
   "metric_id": 3,
   "metric_name": "PVU Full Capacity"
   "threshold": 300
   }]

2. ライセンス・メトリックのしきい値をクリアするには、threshold パラメーターに空の値を指定します。カスタム・フィールドの値をクリアする際にも同じメソッドを使用します。

   要求

   PUT api/sam/v2/license_usage?product_id=29258&metric_id=3
   &threshold=&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
   

   応答

   200 - OK