未加工の課金データの取得

9.2.2 から使用可能です。この API は、コンピューターにインストールされたソフトウェア・アイテムの使用状況に関する情報を含む未加工の課金データを取得します。UI の場合とは異なり、この API を使用すると、データベースに保管されているすべての履歴データを取得できます。

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

始める前に

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

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

https://hostname:port/api/sam/raw_app_usage_property_values?token=token&limit=100
注: 各 API 要求は、token パラメーターを使用して認証する必要があります。これは、認証トークンを取得するための REST API を使用して取得できます。BigFix Inventory にログインして「ユーザー」アイコン にカーソルを移動して、「プロファイル」をクリックすることもできます。次に、「トークンの表示」をクリックします。
1. 操作の説明

表は、2 つの列と 15 の行から成ります。11 行目には、2 つのレベルがあります。

操作の詳細 「説明」
操作 GET /api/sam/raw_app_usage_property_values
目的 未加工のパッケージ・データを返します。
HTTP メソッド GET
リソース URI https://server_host_name:port_number/api/sam/raw_app_usage_property_values
URL リンク関係 n/a
URI 照会パラメーター n/a
要求ヘッダー
ヘッダー
Accept-Language (オプション)
en-US (英語のみをサポート)

応答の言語のネゴシエーションに使用されます。このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。

要求ペイロード n/a
要求 Content-Type
  • application/json
応答ヘッダー
ヘッダー
Content-Type
application/json

応答のコンテンツ・タイプを指定します。

ヘッダー
Content-Language
en-US, …

応答のコンテンツの言語を指定します。このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。

応答ペイロード App Usage Property Value element
応答 Content-Type
  • application/json
正常な HTTP 応答コード
  • 200 – OK
エラーの HTTP 応答コード
  • 500 – “Bad Request” 照会パラメーターにエラーがあるか、照会パラメーターが欠落している場合

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

照会パラメーター

照会パラメーターは、検索結果の絞り込みに使用できます。
2. 照会パラメーター

表は、4 つの列と 9 つの行から成ります。

パラメーター 「説明」 必須
columns[] 取得する列を指定します。このパラメーターを指定しない場合は、一連のデフォルトの列が取得されます。例:
名前と「computer_id」の列を取得します。
URL?columns[]=name&columns[]=computer_id
いいえ ストリング
order 返されたデータのソート方法を指定します。列のソートのデフォルト方向は昇順です。降順ソートを指定する場合は、列名に desc を追加します。例:
名前の降順で並び替えるには、次のように指定します。
URL?order[]=name desc
いいえ ストリング
限界値 取得する行数を指定します。このパラメーターを省略した場合、すべての行が取得されます。10.0.1 までの BigFix Inventory バージョンでは、「limit」パラメーターを省略すると、100,000 行が取得されます。この番号は、「サーバー詳細設定」パネルの raw_data_api_default_limit で定義されます。
注: BigFix Inventory バージョン 10.0.2 以降、パラメーター raw_data_api_default_limit は削除されています。
いいえ 数字
offset 結果の取得でスキップする行数を指定します。これを limit パラメーターと一緒に使用して、結果をページ編集できます。例:
レコード 150 の後から始まる 50 件のレコードを取得するには、次のとおり指定します。
URL?limit=50&offset=150
いいえ 数字
token 固有のユーザー認証 ID。自分のトークンは、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 はそれぞれ、日、週、月、年を表す指定子です。例えば、過去 7 日間の間にレポートしたコンピューター・システムを取得するには、次の API 要求を使用します。
URL?criteria={"and":[["last_seen","last","P7D"]]}

HTTP 会話の例

要求
GET api/sam/raw_app_usage_property_values
?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)
 {
  "app_usage_property_id": -1,  
  "computer_id": 2,
  "process": "BESClient.exe",
  "first_used": "2015-03-27T16:28:47Z",
  "last_used": "2015-08-03T11:46:16Z",
  "total_runs": 5,
  "total_time": 10888494,
  "avg_runs_per_day": 0.03943099252280677,
  "avg_run_time": 2177698.8,
  "valid_from": "2015-08-05T14:41:19Z",
  "valid_to": "9999-12-31T23:59:59Z" 
 }
 {
  "app_usage_property_id": -1,
  "computer_id": 2,
  "process": "BESConsole.exe",
  "first_used": "2015-07-09T11:27:50Z",
  "last_used": "2015-07-13T13:33:42Z",
  "total_runs": 2,
  "total_time": 16767,
  "avg_runs_per_day": 0.4893077201884741,
  "avg_run_time": 8383.5,
  "valid_from": "2015-08-05T14:41:19Z",
  "valid_to": "9999-12-31T23:59:59Z"  
 }