Getting data through the NXQL API (classic)

NXQL APIの概要

NXQL APIは、Nexthinkデータを外部情報システムと統合するためにNexthinkが提供する主要なインターフェースです。 Finderの調査はユーザーにNexthinkデータベースをクエリする手段を提供しますが、調査は外部プログラムによって開始および処理されるのには適していません。 NXQL APIは、サードパーティ製アプリケーションに対し、Nexthinkデータベースをクエリするための標準プログラミングインターフェースを提供することで、このギャップを埋めます。エンジンはNXQL APIをHTTPSを介したRESTful webサービスとして実装しています。したがって、NXQL APIはTLS/SSL（HTTPS）をサポートする任意の外部アプリケーションからリクエストを受け入れることができます。 NXQL APIに接続するためのデフォルトポートは、オンプレミスでは1671、Nexthinkクラウドでは443です。 NXQL APIは外部アプリケーションと通信するために確立されたインターネットプロトコルを使用しているため、多くのツールが直接サポートしています。構成管理データベースや課題追跡システムなどの情報システムは通常、RESTful webサービスにアクセスできます。これらのシステムは、NXQL APIをクエリすることでNexthinkデータの統合による恩恵を迅速に受けることができます。

Nexthink Query Language、Nexthinkクエリ言語を使用して、最も要求の厳しい統合ニーズを満たす高度なクエリを作成します。 GETまたはPOSTメソッドを使用してHTTPSプロトコルでクエリを送信し、選択した形式（XML、JSON、HTML、CSV）でクエリの結果を受け取ります。

前提条件

NXQL APIのプロトコルが機能するためには、エンジンの外部DNS名を適切な値に設定する必要があります。

エンジンがファイアウォールの背後にオンプレミスでインストールされている場合、NXQL API（1671）のデフォルトTCPポート、または代わりに設定したポート番号へのアクセスを開くことを忘れないでください。