未加工のスキャン済みファイル・データの取得

9.2.2 から使用可能です。インフラストラクチャー内のコンピューターで検出されたすべてのファイルに関する情報を要求するには、/api/sam/raw_file_facts エレメントに対して GET 操作を使用します。この API は、既存のファイルの詳細、および削除されたファイルに関する履歴データを返します。デフォルトでは、未加工のデータは 7 日間保持されます。この期間を変更するには、「管理」 > 「サーバー詳細設定」に移動し、raw_data_api_history_keep_days パラメーターの値を変更します。

Note

ユーザー 検出されたソフトウェアに関する情報を取得するには、api/sam/v2/software_instances API を使用します。

始める前に

API 出力をプレビューするときに limit パラメーターを使用する

テスト目的で /api/sam/raw_file_facts API を使用する場合は、応答時間を短縮するために limit パラメーターを追加します。最初の 100 レコードで、利用可能なデータを表示するのに十分である必要があります。

https://hostname:port/api/sam/raw_file_facts?token=token&limit=100

権限

An icon representing a user. You must have the View Raw Data permission to perform this task.

リソース URL

https://hostname:port/api/sam/raw_file_facts?token=token

リソース情報

表 1. リソース情報

表は、2 つの列と 6 つの行から成ります。
操作の詳細 「説明」
HTTP メソッド GET
要求ヘッダー
ヘッダー
Accept-Language (オプション)
値
en-US (英語のみをサポート)

応答の言語をネゴシエーションします。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
要求フォーマット
  • application/json
応答ヘッダー
ヘッダー
Content-Type
値
application/json

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

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

9.2.10 スキーマの説明

この REST API によって返されるすべての列のリストをその説明と一緒に取得するには、次の要求を使用します。
GET api/sam/schemas/raw_file_fact.json?token=token

選択可能な列

表 2. スキャンされたファイルに関する情報が含まれる列
列 「説明」 デフォルトで表示 タイプ
computer_id ファイルが検出されたコンピューターの ID。 ✓ ストリング
path ファイルが検出された場所のパス。 ✓ ストリング
name 検出されたファイルの名前。 ✓ ストリング
size 検出されたファイルのサイズ。 ✓ Integer
バージョン 検出されたファイルのバージョン (使用可能な場合)。 ✓ ストリング
md5 ファイルの MD5 チェックサム。 ✓ ストリング
sha256 ファイルの SHA256 チェックサム。 ✓ ストリング
valid_from ファイルに関する情報が含まれていた最初のインポートの日付。 ✓ ストリング
valid_to ファイルに関する情報が含まれていなかった最初のインポートの日付。値 9999-12-31T23:59:59Z は 、ファイルがまだ検出されていることを示します。 ✓ ストリング
10.0.1 win_hdr_product_name ファイルが配布される製品の名前。 ストリング
10.0.1 win_hdr_copyright ファイルに適用される著作権表示。 ストリング
10.0.1 win_hdr_product_version ファイルが配布される製品のバージョン。 ストリング
10.0.1 win_hdr_description ファイルの説明。 ストリング
10.0.1 win_hdr_company ファイルを作成した会社。 ストリング
10.0.1 win_hdr_trademarks このファイルに適用される商標および登録商標。 ストリング

「win_hdr_」で始まる列には、有効化が必要です。詳細については、「 Windows 実行可能ファイルの追加プロパティーの収集を有効にする」を参照してください。

適用可能な関連付け

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

照会パラメーター

表 3. 照会パラメーター

表は、4 つの列と 9 つの行から成ります。
パラメーター 「説明」 必須 値
columns[] 取得する列を指定します。このパラメーターを指定しなかった場合、デフォルトの列のみが取得されます。
例: ファイルの名前とサイズを取得します。
URL?columns[]=name&columns[]=size
 ストリング
order 返されたデータのソート方法を指定します。列のソートのデフォルト方向は昇順です。降順ソートを指定する場合は、列名に desc を追加します。
例: 名前による並べ替え
URL?order[]=name desc
 ストリング
限界値 取得する行数を指定します。このパラメーターを省略した場合、すべての行が取得されます。10.0.1 までの BigFix Inventory バージョンでは、「limit」パラメーターを省略すると、100,000 行が取得されます。この番号は、「サーバー詳細設定」パネルの raw_data_api_default_limit で定義されます。
例: 100 件のレコードの取得
URL?limit=100
注: BigFix Inventory バージョン 10.0.2 以降、パラメーター raw_data_api_default_limit は削除されています。
 数字
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-numver> | <json-null>

演算子について詳しくは、共通のコネクターおよび演算子を参照してください。

例: ID が 10 より大きいコンピューター・システムからのスキャン済みファイル・データの取得:
URL?criteria={ "and": [ ["computer_id", ">", "10"]]}

「前回表示日時」など、日時の値を使用する列の場合、特定の日付の代わりにある期間のデータを取得することもできます。これを行うには、last または next を <operator> として使用し、次の規則で時刻の値を指定します。PxD/PxW/PxM/PxY。ここで、x は 1 から 999 の範囲の数値であり、D、W、M、Y はそれぞれ、日、週、月、年を表す指定子です。

例:BigFix Inventory で過去 7 日間に初めて報告されたコンピューターから情報を取得
URL?criteria={"and":[["valid_from","last","P7D"]]}

会話例 - デフォルトの列

要求
GET api/sam/raw_file_facts
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
応答本文
 {
  "computer_id": 5,
  "path": "C:\BES\BESAirgapTool",
  "name": "BESAirgapTool.exe",
  "size": 92174,
  "version": null,
  "valid_from": "2015-07-31T07:03:21Z"
  "valid_to": "9999-12-31T23:59:59Z"
 }
 {
  "computer_id": 5,
  "path": "C:/Program Files/ibm/SQLLIB/BIN",
  "name":"db2set.exe",
  "size": 81768,
  "version": "10.1",
  "valid_from": "2015-07-31T07:03:21Z",
  "valid_to": "9999-12-31T23:59:59Z"
  }

会話の例 - 追加の Windows パラメーター

要求
GET api/sam/raw_file_facts
?columns[]=win_hdr_product_name
&columns[]=win_hdr_copyright
&columns[]=win_hdr_product_version
&columns[]=win_hdr_description
&columns[]=win_hdr_company
&columns[]=win_hdr_trademarks
&criteria=
{"and":[["win_hdr_copyright","!=",""]]}
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081
Accept: application/json
Accept-Language: en-US
応答
{
"win_hdr_product_name":"Microsoft (R) Visual Studio (R) 2010",
"win_hdr_copyright":"Ac Microsoft Corporation. All rights reserved.",
"win_hdr_product_version":"10.0.40219.1",
"win_hdr_description":"WebDev.WebServer40.exe",
"win_hdr_company":"Microsoft Corporation",
"win_hdr_trademarks":""
}