BigFix Inventory のバージョンを取得するための REST API

BigFix Inventory のバージョンに関する情報を要求するには、api/sam/about エレメントに対して GET 操作を使用します。

BigFix Inventory の現行バージョンに関する情報を取得するには、次の URL を使用します。 
https://hostname:port/api/sam/about?token=token
重要:
  • この API を使用するには、「すべてのコンピューター」グループに割り当てられていて、「ハードウェア・インベントリーの表示」権限が付与されている必要があります。
  • 各 API 要求は、token パラメーターを使用して認証する必要があります。認証トークンを取得するための REST API を使用して取得することができます。BigFix Inventory にログインして「ユーザー」アイコン「ユーザー」アイコンにカーソルを移動して、「プロファイル」をクリックすることもできます。次に、「トークンの表示」をクリックします。
  • デフォルトでは、取得したデータは id 別にソートされます。
表 1. 操作の説明
操作の詳細 「説明」
操作 GET /api/sam/about
目的 BigFix Inventory のバージョンを返します
HTTP メソッド GET
リソース URI https://server_host_name:port_number/api/sam/about
URL リンク関係 n/a
URI 照会パラメーター n/a
要求ヘッダー
ヘッダー
Accept-Language (オプション)
値
en-US (英語のみをサポート)

応答の言語のネゴシエーションに使用されます。このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
要求ペイロード n/a
要求 Content-Type
  • application/json
応答ヘッダー
ヘッダー
Content-Type
値
application/json

応答のコンテンツ・タイプを指定します。
ヘッダー
Content-Language
値
en-US, …

応答のコンテンツの言語を指定します。このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
応答ペイロード About element
応答 Content-Type
  • application/json
正常な HTTP 応答コード
  • 200 – OK
エラーの HTTP 応答コード
  • 500 – “Bad Request” 照会パラメーターにエラーがあるか、照会パラメーターが欠落している場合

メッセージの本文にはエラー・メッセージと詳細が含まれます。

HTTP 会話の例

要求
GET api/sam/about
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
応答ヘッダー
HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US
応答の本文 (JSON)
{
"product": "BigFix Inventory",
"version": "9.2.20140331-2015"
}