コントラクトを管理するための REST API

/api/sam/v2/contracts.json API を使用すると、購入情報を使用してコントラクト・データをインポートおよびエクスポートできます。この操作は、外部購入システムとの統合を自動化するために使用されます。コントラクトを管理するために、コントラクト CSV のインポート、ユーザー・インターフェース - 「すべてのコントラクト」パネルおよび非推奨のコントラクト移行を使用することもできます。

API を使用する前に、コントラクトの追加と更新の制限を確認してください。

権限

ユーザーコントラクトのコンピューター・グループへのアクセス権限とともに「コントラクトの管理」権限が必要です。

リソース URL

https://hostname:port/api/sam/v2/contracts?token=<token>

構文

GET /api/sam/v2/contracts.json

スキーマの説明

/api/sam/v2/schemas/contract.json

アソシエーション

選択可能な列


Column name (列名)	説明	重要度
contract_id	コントラクトの識別子。コントラクトが更新されるのは、コントラクト ID が使用可能な場合のみです。コントラクト ID はすべてのコントラクトの中で固有でなければなりません。 UI では自動的に生成されます。タイプ: 文字列	必須
name	契約の名前。タイプ: 文字列	オプション
type	コントラクトのタイプ: 1 - ライセンス、2 - サポート、3 - サービス、4 - ハードウェア、5 - その他。タイプ: 整数	オプション
しきい値	コントラクトの測定値のしきい値。指定は任意です。タイプ: 整数	オプション
computer_group	コントラクトのコンピューター・グループ・オブジェクト。コンピューター・グループ列のリストを確認するには、computer_group を参照してください。	オプション
メトリック	コントラクトのメトリック・グループ・オブジェクト。メトリック列のリストを確認するには、メトリックを参照してください。	オプション
purchase_order	コントラクトに割り当てられた購入注文の配列。購入注文の列のリストを確認するには、purchase_orders を参照してください。	オプション
software_products	コントラクトに割り当てられたソフトウェア製品の配列。ソフトウェア製品の列のリストを確認するには、software_product を参照してください。	オプション

注: すべての関連付け、computer_group、metric、purchase_order、および software_product はオプションです。computer_group の関連付けが指定されておらず、コントラクトが作成されている場合は、「すべてのコンピューター」グループが使用されます。

使用可能なメトリック

使用可能なメトリックのリストについては、メトリック ID およびコード名および10.0.4 ライセンス・メトリックを管理するための REST APIを参照してください。コントラクトに適用されないメトリックは、INTERNAL_PVU と INTERNAL_RVU_MAPC です。

コントラクトの要求に列が指定されていない場合、関連するコントラクトのデータは変更されません。
フィールドをクリアするには、null 値 (「contract_custom_field_1」: null、「しきい値」null など) を使用します。
要求が無効であるか、処理中にエラーが発生した場合、コントラクトまたは関連データは更新されません。応答では、「rowErrors」の下の無効なコントラクトごとに詳細な説明が提供されます。エントリーの番号付けは 1 から始まります。

{
   "incorrectRows":7,
   "allRows":7,
   "message":{"code":"CODUI4099E","text":"Contract processing failed. The contracts have not been imported."},
   "rowErrors":{"1":["|CODUI4047E|Required field contract_id is empty",
   "|CODUI4057E|Custom field with ID 2 is required"],"2":
   [
     "|CODUI4057E|Custom field with ID 2 is required"],
    "3":
     [
      "|CODUI4042E|A contract with the specified contract ID already exists",
      "|CODUI4057E|Custom field with ID 2 is required"],"4":["|CODUI4057E|Custom field with ID 2 is required"],
      "5":["|CODUI4057E|Custom field with ID 2 is required"],"6":["|CODUI4057E|Custom field with ID 2 is required"],
      "7":["|CODUI4040E|A contract with the specified name and type already exists"
    ]
  }
}