REST API

アプリケーション・ユーザー・インターフェースを使用して大量の情報を管理すると、多大な時間がかかる場合があります。グラフィカル・ユーザー・インターフェースの代わりに REST API を使用すると、ソフトウェア・インベントリー、およびソフトウェア・カタログのコンテンツを管理するために必要な時間を削減できます。

認証トークンを取得するための REST API

重要: BigFix Inventory にログインしていないときに REST API を使用する場合は、それぞれの照会で token パラメーターを指定する必要があります。トークンを確認するには、BigFix Inventory にログインして「ユーザー」アイコン 「ユーザー」アイコンにカーソルを移動して、「プロファイル」をクリックします。次に、「トークンの表示」をクリックします。

BigFix Inventory にログインしているときは、token パラメーターは不要です。

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

単一の API 要求を使用して、選択したコンピューターのサブセットからのみデータを取得しても、BigFix Inventory のパフォーマンスに大きな影響を与えることはありません。ただし、すべてのコンピュータ・システムから同時にデータを大量に取得する場合は影響が発生します。REST API のパフォーマンスを向上させるには、データをチャンクで取得します。詳しくは、下記を参照してください。REST API に関する考慮事項。

制約事項: データベース接続に問題が発生する可能性があるため、インポート中は REST API を使用しないでください。問題が発生した場合は、インポートが終了するまで待機して、BigFix Inventory サーバーが稼働中であることを確認してください。その後、API 呼び出しを繰り返します。

API 応答言語

API 応答の言語は、以下の基準に応じて異なります。
ユーザーが認証される場合
  • ユーザーのプロファイル言語は次のようにデフォルト言語に設定されます。
    • 要求で「Accept-Language」ヘッダーが定義されていて、言語が BigFix Inventory でサポートされている場合、API 応答は定義された言語で表示されます。言語が BigFix Inventory でサポートされていない場合、応答はフォールバック言語で表示されます。
    • ブラウザーの言語が BigFix Inventory でサポートされている場合、応答は選択した言語で表示されます。ブラウザーの言語が BigFix Inventory でサポートされていない場合、応答は英語で表示されます。
  • ユーザーのプロファイル言語は次のようにデフォルトに設定されません。
    • API 応答は選択したユーザー・プロファイル言語で表示されます。
ユーザーが認証されない場合
  • 要求で「Accept-Language」ヘッダーが定義されていて、言語が BigFix Inventory でサポートされている場合、API 応答は定義された言語で表示されます。言語が BigFix Inventory でサポートされていない場合、応答はフォールバック言語で表示されます。
  • 要求で「Accept-Language」ヘッダーが定義されていない場合、応答は英語で表示されます。
注: フォールバック言語設定は、config/lmt_settings.yml の pristine_installer_language プロパティーなど、構成ファイルで設定した言語によって異なります。これは、サポートされる言語として設定する必要があります。言語がサポートされていない場合、デフォルト言語は英語になります。

省略形

REST API に関連する資料では、以下の省略語が使用されます。

HTTP
Hyper Text Transfer Protocol。HTTP バージョン 1.1 は、RFC 2616 で規定されている。別途記載がない限り、HTTP という用語の使用は、HTTP と HTTPS の両方を示す。
HTTPS
Hyper Text Transfer Protocol Secure (RFC 2818 で規定)。
JSON
JavaScript™ Object Notation (ECMA-262 で規定)。
REST
Representational State Transfer (『Architectural Styles and the Design of Network-based Software Architectures』で起草され非公式に規定)。
URI
Uniform Resource Identifier (RFC 3986、Draft 5 で規定)。