ライセンス・メトリックを管理するための REST API

ライセンス・メトリックの取得

api/sam/v2/metrics エレメントに対して GET 操作を使用して、BigFix Inventory に定義または存在するライセンス・メトリックに関する情報を要求します。

api/sam/v2/metrics API を使用するには、「コントラクトの表示」と「コントラクトの管理」権限が必要です。

ライセンス・メトリックの追加および更新

ライセンス・メトリックの追加

api/sam/v2/metrics エレメントに対して POST 操作を使用し、新しいライセンス・メトリックを作成します。

応答属性

1. POST 操作を使用してメトリックを作成します

   要求

   POST https://localhost:9081/api/sam/v2/metrics?code_name=METRIC_POST&display_name=DISPLAY&token=6b884e39d8d34e05192c5d72dd6739607293b828

   応答

   
   200 ok
   Response body (JSON)
   {
   "id": 32468,
   "code_name": "METRIC_POST",
   "display_name": "DISPLAY",
   "source_type": 2,
   "source_id": 32468
   }

2. メトリックの作成に失敗しました。メトリックは既に存在します。

   要求

   POST
   https://localhost:9081/api/sam/v2/metrics?code_name=METRIC_POST&display_name=DISPLAY&token=6b884e39d8d34e05192c5d72dd6739607293b828

   応答

   400 Bad Request
   Response body (JSON)
   {
   "error":  "Metric already present" 
   }

3. メトリックの作成に失敗しました。コード名または表示名が正しくありません。

   要求

   POST
   https://localhost:9081/api/sam/v2/metrics?code_name=metric_post&display_name=DISPLAY&token=6b884e39d8d34e05192c5d72dd6739607293b828

   応答

   400 Bad Request
   Response body (JSON)
   {
   "error": "Metric code name or display name not proper"
   }

ライセンス・メトリックの更新

api/sam/v2/metrics エレメントに対して PUT 操作を使用し、既存のメトリックの表示名を更新します。

1. PUT 操作を使用してメトリックを更新します

   要求

   PUT
   https://localhost:9081/api/sam/v2/metrics?code_name=CONCURRENT_USER&display_name=Updatedvalue&token=6b884e39d8d34e05192c5d72dd6739607293b828

   応答

   200 ok
   Response body (JSON)
   {
   "id": 27,
   "code_name": "CONCURRENT_USER",
   "display_name": "Updated value",
   "source_type": 1,
   "source_id": 27
   }

2. メトリックの更新に失敗しました。メトリックが存在しません。

   要求

   PUT
   https://localhost:9081/api/sam/v2/metrics?code_name=NOT_PRESENT&display_name=DISPLAY&token=6b884e39d8d34e05192c5d72dd6739607293b828

   応答

   400 Bad Request
   Response body (JSON)
   {
   "error": "Metric does not exist"
   }

3. メトリックの更新に失敗しました。表示名の長さが 254 を超えています。

   要求

   PUT
   https://localhost:9081/api/sam/v2/metrics?code_name=CONCURRENT_USER&display_name=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA 2&token=6b884e39d8d34e05192c5d72dd6739607293b828

   応答

   400 Bad Request
   Response body (JSON)
   {
   "error": "Display name length is too long"
   }

4. メトリックの更新に失敗しました。非カスタム・メトリックの更新を試行します。

   要求

   https://localhost:9081/api/sam/v2/metrics?code_name= VU_VALUE_UNIT &display_name=Updatedvalue&token=6b884e39d8d34e05192c5d72dd6739607293b828

   応答

   403 Forbidden
   Response body (JSON)
   {
   "error": "VU_VALUE_UNIT metric update not allowed"
   }

ライセンス・メトリックの削除

ライセンス・メトリックを削除するには、api/sam/v2/metrics エレメントに対して DELETE 操作を使用します。

応答属性

HTTP 会話の例

1. メトリックが正常に削除されました

   要求

   DELETE
   https://localhost:9081/api/sam/v2/metrics?code_name=TEST&token=6b884e39d8d34e05192c5d72dd6739607293b828

   応答

   200 ok
   Response body (JSON)
   {
   }

2. メトリックの削除に失敗しました

   要求

   DELETE
   https://localhost:9081/api/sam/v2/metrics?code_name=TEST&token=6b884e39d8d34e05192c5d72dd6739607293b828

   応答

   400 Bad Request
   Response body (JSON)
   {
   "error": "Metric does not exist"
   }

3. 非カスタム・メトリックの削除に失敗しました

   要求

   DELETE
   https://localhost:9081/api/sam/v2/metrics?code_name= VU_VALUE_UNIT&token=6b884e39d8d34e05192c5d72dd6739607293b828

   応答

   Response
   403 Forbidden
   Response body (JSON)
   {
   "error": "VU_VALUE_UNIT metric delete not allowed"
   }