ホーム
REST API との統合
外部システム統合は、BigFix Inventory の主要な機能の一つです。統合のためのビジネス・ロジックが使用可能であり、共通の統合ポイント用のインターフェースが提供されています。
REST API
アプリケーション・ユーザー・インターフェースを使用して大量の情報を管理すると、多大な時間がかかる場合があります。グラフィカル・ユーザー・インターフェースの代わりに REST API を使用すると、ソフトウェア・インベントリー、およびソフトウェア・カタログのコンテンツを管理するために必要な時間を削減できます。
コア API
コア API には、BigFix Inventory と統合された API のすべての基本セットが含まれます。
REST API の関連付け
9.2.8 から使用可能です。バージョン 2 の REST API では、関連付けを使用して、API 要求の一部として、追加のデータを取得できます。例えば、software_instances API 要求の一部として、コンピューター・ハードウェアに関する詳細情報を取得できます。

REST API との統合
外部システム統合は、BigFix Inventory の主要な機能の一つです。統合のためのビジネス・ロジックが使用可能であり、共通の統合ポイント用のインターフェースが提供されています。
- REST API
  アプリケーション・ユーザー・インターフェースを使用して大量の情報を管理すると、多大な時間がかかる場合があります。グラフィカル・ユーザー・インターフェースの代わりに REST API を使用すると、ソフトウェア・インベントリー、およびソフトウェア・カタログのコンテンツを管理するために必要な時間を削減できます。
  - ソフトウェア製品とソフトウェア・コンポーネント
    BigFix Inventory は、製品にバンドルされているソフトウェア・コンポーネントを検出します。
  - REST API リソースおよび HTTP メソッド
    BigFix Inventory REST API プロトコルの操作は、特定の REST リソースに対する HTTP メソッドとして定義されます。
  - 共通の REST API エレメント
    コネクターおよび演算子を使用すると、一致する条件および値に基づいてフィルタリングを行う照会セグメントを作成できます。
  - REST API バージョンのマッピング
    9.2.8 から使用できます。一部の REST API では、バージョン 2 が作成され、機能やエクスペリエンスが向上しています。そのような場合、元の API は時間とともに非推奨になり、バージョン 2 のみがさらに開発されます。そのような REST API に基づいているカスタム・ツールまたは内部プロセスがある場合は、新しいバージョンの API を使用するようにツールを調整することをお勧めします。
  - 認証トークンを取得するための REST API
    REST API 要求を認証するために必要なユーザー固有のトークンを要求するには、api/get_token エレメントに対して POST 操作を使用します。
  - BigFix Inventory のバージョンを取得するための REST API
    BigFix Inventory のバージョンに関する情報を要求するには、api/sam/about エレメントに対して GET 操作を使用します。
  - コア API
    コア API には、BigFix Inventory と統合された API のすべての基本セットが含まれます。
    - ハードウェア用 REST API (v2)
      9.2.8 から使用可能です。REST API 要求を使用して、削除されたコンピューターに関する履歴データも含め、ハードウェア・インベントリーに関連した大量のデータを迅速に取得できます。その後、そのデータを他のアプリケーションに渡して、さらに処理したり分析したりすることができます。
    - ソフトウェア・インベントリーおよびメトリック使用状況を取得してソフトウェアを分類するための REST API (v2)
      9.2.8 から使用可能です。REST API 要求を使用して、アンインストールされたコンピューターに関する履歴データも含め、ライセンス・メトリック使用状況とソフトウェア・インベントリーに関連した大量のデータを迅速に取得できます。その後、そのデータを他のアプリケーションに渡して、さらに処理したり分析したりすることができます。
    - REST API の関連付け
      9.2.8 から使用可能です。バージョン 2 の REST API では、関連付けを使用して、API 要求の一部として、追加のデータを取得できます。例えば、software_instances API 要求の一部として、コンピューター・ハードウェアに関する詳細情報を取得できます。
      - component_cpe 関連付け
        9.2.12 から使用可能です。component_cpe 関連付けを使用して、他の REST API 要求の一部として、Common Platform Enumeration (CPE) の辞書に指定されているとおり、検出されたコンポーネントに関する情報を取得します。
      - computer 関連付け
        9.2.10 から使用可能。computer 関連付けを使用して、他の REST API 要求の一部として、コンピューターの詳細と、カスタム・コンピューター・プロパティーに関する情報を取得します。
      - computer_details 関連付け
        9.2.10 から使用可能です。computer_details 関連付けを使用して、他の REST API 要求の一部として、コンピューターの詳細と、カスタム・コンピューター・プロパティーに関する情報を取得します。
      - computer_health 関連付け
        9.2.8 から使用可能です。computer_health 関連付けを使用して、REST API 要求の一部として、ソフトウェア・スキャンの状況やインストールされている BigFix クライアントのバージョンなど、コンピューターの状態に関する情報を取得します。
      - computer_hardware 関連付け
        9.2.8 から使用可能です。computer_hardware 関連付けを使用して、他の REST API 要求の一部として、ハードウェア詳細情報を取得します。
      - cve 関連付け
        9.2.13 から使用可能。cve 関連付けを使用して、他の REST API 要求の一部として、特定のコンポーネントの詳細バージョンと一致した共通脆弱性と暴露 (CVE) に関する情報を取得します。
      - discovery_details 関連付け
        9.2.11 から使用可能。discovery_details 関連付けを使用して、REST API 要求の一部として、コンポーネント検出の原因となったファイルの詳細を取得します。詳細には、ファイルの名前とサイズ、およびファイルが検出されたパスが含まれます。
      - designated_computer 関連付け
        9.2.12 から使用可能です。designated_computer 関連付けを使用して、他の REST API 要求の一部として、共有ディスクをスキャンするように指定されたコンピューターに関する情報を取得します。
      - mounted_shared_disks 関連付け
        9.2.12 から使用可能です。mounted_shared_disks 関連付けを使用して、他の REST API 要求の一部として、各コンピューターにマウントされている共有ディスクに関する情報を取得します。
      - release_component_lifecycle 関連付け
        9.2.13 から使用可能。release_component_lifecycle 関連付けを使用して、他の REST API 要求の一部として、コンポーネントのサポート終了日に関する情報を取得します。
      - shared_disk_members 関連付け
        9.2.12 から使用可能です。shared_disk_members 関連付けを使用して、他の REST API 要求の一部として、共有ディスクがマウントされているコンピューターに関する情報を取得します。
      - tags 関連付け
        9.2.14 から使用可能です。tags 関連付けを使用して、他の REST API 要求の一部として、タグに関する情報を取得します。
      - usage_data 関連付け
        9.2.8 から使用可能です。usage_data 関連付けを使用して、他の REST API 要求の一部として、アプリケーション使用状況に関する情報を取得します。
      - Computer group 関連付け
        Computer group 関連付けを使用して、コントラクトに関連付けられたコンピューター・グループに関する情報を取得します。
      - Metric 関連付け
        metric 関連付けを使用して、コントラクトに関連付けられたメトリックに関する情報を取得します。
      - Purchase orders 関連付け
        purchase_orders 関連付けを使用して、コントラクトに関連付けられた購入注文に関する情報を取得します。
      - Software products 関連付け
        software_products 関連付けを使用して、コントラクトに関連付けられたソフトウェア製品に関する情報を取得します。
    - 未加工のスキャン結果を取得するための REST API
      9.2.2 から使用可能です。REST API を使用した未加工スキャン結果の取得は、最近インストールまたは変更されたソフトウェアを素早くディスカバーできるようにすることで、環境のモニタリングを効果的に行うことを目的としたものです。短縮されたデータ・インポートを使用することで、ソフトウェアに関するデータがサーバーにより速く到達し、また同時に、毎日実行できるインポートの数を増やすことができます。
    - 統合ビューの取得
      統合ビュー API は、インスタンスの統一されたビューを提供します。
  - 構成 API
    構成 API には、アプリケーションの構成に必要なすべての API が含まれます。
  - 履歴 API
    一部の REST API では、バージョン 2 が作成され、機能やエクスペリエンスが向上しています。このような場合、元の API は非推奨となり、バージョン 2 がサポートされます。カスタム・ツールまたは内部プロセスを、これらの API の新しいバージョンに合わせて調整する必要があります。

REST API の関連付け

9.2.8 9.2.8 から使用可能です。バージョン 2 の REST API では、関連付けを使用して、API 要求の一部として、追加のデータを取得できます。例えば、software_instances API 要求の一部として、コンピューター・ハードウェアに関する詳細情報を取得できます。

構文

追加のデータを取得するには、以下の構文の照会を使用します。

<URL>?columns[]=<association>.<column>&token=<token>

各部の意味は以下のとおりです。

<URL> は、REST API 要求です
<association> は、列を取得する関連付けの名前です
<column> は、取得する列の名前です
<token> は、固有のユーザー認証 ID です

例:

GET api/sam/v2/software_instances?columns[]=computer_health.catalog_version
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623

注: API 関連付けを使用して、既存の API では直接取得できない情報を取得します。