パッケージ・データとソフトウェア・インスタンス・データを結合する統合ソフトウェア API

10.0.5 /api/sam/unified/current/software API を使用すると、現在インストールされているソフトウェア・インスタンスとパッケージ・データを一緒に表示することができます。

検出されたソフトウェアに対応する 1 つの API とのシンプル化された統合

API に以下の情報が表示されます。
  • 現在インストールされているソフトウェア・インスタンスおよびパッケージ・データ
  • 抑止されないソフトウェア・インスタンスおよびパッケージ・データ
  • 認識されないパッケージ・データ
  • 以下のような、コンピューターの関連付けを介してアクセスできるコンピューター・データ computer 関連付け

権限

ユーザー この API を使用するには、「エンドポイントの表示」と「生データの表示」の権限が必要です。

リソース URL

https://hostname:port/api/sam/unified/current/software?token=<token>

構文

GET /api/sam/unified/current/software?token=<token>

リソース情報

表 1. リソース情報
操作の詳細 説明
HTTP メソッド GET
要求ヘッダー
ヘッダー
Accept-Language (オプション)
値
en-US (英語のみをサポート)

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

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

応答のコンテンツの言語を指定します。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
応答ペイロード Unified Software element
応答フォーマット application/json
応答コード

200 – OK

400 – "Bad Request" 照会パラメーターにエラーがあるか、照会パラメーターが欠落している場合

スキーマの説明

この関連付けによって返されるすべての列のリストをその説明と一緒に取得するには、次の要求を使用します。
GET /api/sam/unified/current/schemas/software.json?token=<token>

利用可能な列

表 2. コンピューターの詳細に関する情報が含まれる列
列 説明 デフォルトで表示 タイプ
id コンポーネント・インスタンスまたはパッケージの識別子。 ✓ 数値
名前 コンポーネントまたはパッケージの名前。 ✓ ストリング
リリース コンポーネントまたはパッケージ・バージョンのリリース。 ✓ ストリング
detailed_version コンポーネントまたはパッケージ・バージョンの詳細バージョン。 ✓ ストリング
discoverable_guid コンポーネントのグローバル一意識別子 (GUID) またはパッケージの sha1。 ✓ ストリング
discoverable_family_guid コンポーネントのファミリー GUID。パッケージの場合、戻り値は null です。 ✓ ストリング
publisher_name コンポーネントの発行者またはパッケージ・ベンダー。 ✓ ストリング
discovery_start コンポーネントまたはパッケージが初めてレポートされた日時。時間は、GMT タイム・ゾーンで示されます。 ✓ ストリング
discovery_path インストール・パスは、 /api/sam/raw_unix_package_facts および /api/sam/unified/current/software API で使用できます。

BigFix Inventory のバージョンが 10.0.12 未満である場合:
  • コンポーネントがインストールされているフォルダーへのパス
  • Windows パッケージの場合: 戻り値は null
  • Unix パッケージの場合: 戻り値は null
FBigFix Inventory のバージョンが 10.0.12 未満である場合:
  • コンポーネントがインストールされているフォルダーへのパス
  • Windows パッケージの場合: これがパッケージのインストールパス
  • Unix パッケージの場合: 戻り値は null

10.0.13 FBigFix Inventory のバージョンが 10.0.13 以降である場合:

  • バージョン 10.0.13 以降では、インストール・パスが Linux パッケージのためにも収集されます。
重要: インストール・パスが長いパッケージの場合、インストール・パスは短縮されます。インストール・パスが空の場合もあります。たとえば、ライブラリーの場合。
 ✓ ストリング
注:

BigFix Inventory バージョン 10.0.15 では、「discovery_path」プロパティのパスの最後に不要な end-of-line (eol) ' \n’ 文字が含まれている欠陥が修正されました。例えば、パス「C:\Program Files (x86)\Mozilla Firefox\n」がこれに該当します。
ソース ソフトウェアのタイプ:
  • 0: コンポーネント・インスタンス
  • 1: Windows パッケージ
  • 2: Unix パッケージ
 数値
computer.id ソフトウェアが検出されたコンピューターの ID。 ✓ 数値
computer.name ソフトウェアが検出されたコンピューターの名前。 ✓ ストリング

適用可能な関連付け

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

クエリー・パラメーター

表 3. クエリー・パラメーター
パラメーター 説明 必須 値
columns 取得する列を指定します。このパラメーターを指定しなかった場合、デフォルトの列のみが取得されます。
例: リリースを取得する
URL?columns[]=name&columns[]=release
 ストリング
order 返されたデータのソート方法を指定します。列のソートのデフォルト方向は昇順です。降順ソートを指定する場合は、列名に desc を追加します。
例: ID で降順に並べ替える
URL?order[]=id desc
 英数字
limit 取得する行数を指定します。このパラメーターを省略した場合、すべての行が取得されます。
例: 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>

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

例: 名前に「BigFix」が含まれているか、ディスカバリー開始が特定の日付範囲内であるソフトウェア・インスタンスの取得
URL?criteria={ "or": [ ["name", "contains", "BigFix"], 
{ "and": [ ["discovery_start", ">", "2018-10-01T00:00:00+00:00Z"], 
["discovery_start", "<", "2018-10-02T00:00:00+00:00Z"] ] } ] }

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

例: 過去 7 日間に初めて報告されたソフトウェア・インスタンスの取得
URL?criteria={"and":[["discovery_start","last","P7D"]]}
 ストリング

会話例

抑止された Windows パッケージを確認するには、以下の API を使用します。
GET api/sam/raw_package_facts?columns[]=name&columns[]=
is_suppressed&columns[]=comment&criteria=
{"and":[["is_suppressed","=",1]]}
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
抑止された UNIX パッケージを確認するには、以下の API を使用します。
GET api/sam/raw_unix_package_facts?columns[]=name&columns[]=
is_suppressed&columns[]=comment&criteria=
{"and":[["is_suppressed","=",1]]}
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
抑止されたソフトウェア・インスタンスを確認するには、以下の API を使用します。
GET /api/sam/v2/software_instances?columns[]=component_name&columns[]
=component_release&columns[]=is_suppressed&columns[]=exclusion_or_suppress_comment&criteria=
{"and":[["is_suppressed","=",1]]}
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
関連するコンピューター・データを表示するには、以下の API を使用します。
GET /api/sam/unified/current/software?columns[]=name&columns[]=release&columns[]
=computer.name&columns[]=computer.ip_address
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623