ソフトウェア・コンポーネントの取得 (v2)

9.2.14 9.2.14 から使用可能です。カタログ内のソフトウェア・コンポーネントに関する情報を要求するには、api/sam/v2/software_components エレメントに対して GET 操作を使用します。この API は、既存のコンポーネントの詳細、および削除されたコンポーネントに関する履歴データを返します。

権限

An icon representing a user. You must have the View Software Catalog and Signatures permission to perform this task.

リソース URL

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

リソース情報

表 1. リソース情報
操作の詳細	「説明」
HTTP メソッド	`GET`
要求ヘッダー	ヘッダー `Accept-Language` (オプション) 値 en-US (英語のみをサポート) 応答の言語をネゴシエーションします。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
要求フォーマット	`application/json`
応答ヘッダー	ヘッダー `Content-Type` 値 `application/json` 応答のコンテンツ・タイプを指定します。
応答ヘッダー	ヘッダー `Content-Language` 値 en-US, … 応答のコンテンツの言語を指定します。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
応答ペイロード	`Software Components` element
応答フォーマット	`application/json`
応答コード	`200 – OK` `500 – "Bad Request"` 照会パラメーターにエラーがあるか、照会パラメーターが欠落している場合

スキーマの説明

この REST API によって返されるすべての列のリストをその説明と一緒に取得するには、次の要求を使用します。

GET api/sam/v2/schemas/software_component.json?token=<token>

選択可能な列

表 2. 選択可能な列
列	「説明」	デフォルトで表示	タイプ
ID	コンポーネント・インスタンスの識別子。	✓	数字
name	コンポーネントの名前。	✓	ストリング
release	コンポーネントのリリース。	✓	ストリング
guid	コンポーネントの GUID。	✓	ストリング
is_ibm	コンポーネントが IBM ソフトウェア・コンポーネントであるかどうかについての情報。	✓	ブール値

適用可能な関連付け

以下の関連付けからデータを追加で取得できます。

tags

照会パラメーター

表 3. 照会パラメーター
パラメーター	「説明」	必須	値
columns[]	取得する列を指定します。このパラメーターを指定しなかった場合、デフォルトの列のみが取得されます。例: コンポーネント名と ID の取得 `URL?columns[]=name&columns[]=id`		ストリング
order	返されたデータのソート方法を指定します。列のソートのデフォルト方向は昇順です。降順ソートを指定する場合は、列名に `desc` を追加します。例: コンポーネント ID の降順での並び替え `URL?order[]=id desc`		英数字
限界値	取得する行数を指定します。このパラメーターを省略した場合、すべての行が取得されます。例: 100 件のレコードの取得 `URL?limit=100`		数字
offset	結果の取得でスキップする行数を指定します。これを limit パラメーターと一緒に使用して、結果をページ編集できます。例: レコード 150 の後から始まる 50 件のレコードの取得 `URL?limit=50&offset=150`		数字
token	固有のユーザー認証 ID。認証トークンを取得するための REST API を使用して取得することができます。BigFix Inventory にログインして「ユーザー」アイコンにカーソルを移動して、「プロファイル」をクリックすることもできます。次に、「トークンの表示」をクリックします。	✓	英数字
criteria	特定の条件と合致するレコードを取得します。このパラメーターでは、以下の構造が 1 行で記述されている必要があります。 `<criteria> ::= <left-brace> <boolean-operator> <colon> <left-bracket> <criterion> [{ <comma> <criterion> }...] <right-bracket> <right-brace> <boolean-operator> ::= "and" \| "or" <criterion> ::= <criteria> \| <left-bracket> <column> <comma> <operator> <comma> <value> <right-bracket> <column> ::= <json-string> <operator> ::= <json-string> <value> ::= <json-array> \| <json-string> \| <json-number> \| <json-null>` 演算子について詳しくは、以下を参照してください。「共通のコネクターおよび演算子」。		ストリング

会話例 - デフォルトの列

要求

GET api/sam/v2/software_components?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US

応答本文

[{
"id":1,
"name":"DB2 8.1",
"release":8,
"guid":"XYZ",
"is_ibm":1,
}]

会話例 - 関連付け

要求

GET api/sam/v2/software_components?columns[]=id&columns[]=name
&columns[]=tags.name
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US

応答本文

[{
"id":1,
"name":"DB2 8.1",
"tags":
[{"name":"ibm"}]
}]