サポート (英語のみ)

リモートアクションAPIによるトリガー(クラシック)

この記事で説明されているいくつかの機能は、Finder (クラシック) に関連しています

{% ヒントのスタイル="情報" %}

Nexthink Finderは、Windows専用のデスクトップアプリケーションで、その機能は現在NexthinkのWebインターフェース内で利用可能です。 Nexthinkは現在ブラウザから直接使用可能であり、ほとんどの機能は追加のデスクトップアプリケーションなしで利用できます。

Nexthink ActのAPIを使用することで、プログラム的にリモートアクションをトリガーし、セルフサービスポータルやチケッティングシステムなどのサードパーティ製品と統合することが可能になります。

リモートアクションのAPIはNexthink WebインターフェースによってREST APIとして公開されています。 現在の記事はAct API v2を文書化しています。

前提条件

Act APIを通してリモートアクションをトリガーするには、以下の前提条件が適用されます:

  • リモートアクションは手動でトリガーできます。

  • リモートアクションは、Finderへのアクセスを含むプロフィールにユーザーが代わってトリガーされ、リモートアクションのAPIを許可するオプションがオンになっています。

Act APIを呼び出す

Nexthink Webインターフェースは、以下のURLでAct APIをREST APIとして公開しています:

https://[portal.company.com]/api/remoteaction/v2/run

URLでは、[portal.company.com]をNexthink Webインターフェースの外部DNS名に置き換えてください。

\nリモートアクションをトリガーするには、APIのURLにPOSTリクエストを送信してください（なお、GETリクエストはサポートされておらず、404エラーを返します）。JSONペイロードに2つのパラメータを含めます:

名前
説明

requestUid

（任意）ロギング目的のリクエストの識別子。

remoteActionUid

リモートアクションの識別子。

deviceUids

ターゲットにするデバイス識別子のリスト。

engineDatabaseUids

（任意）ターゲットにするエンジン識別子のリスト。

timeoutSeconds

（任意）秒単位のリクエストタイムアウト。 Nexthink Webインターフェイスで構成されたデフォルトのタイムアウト（60秒）を上書きします。

params​

（任意）パラメータの入力と値のリスト​。 不明なパラメータ名は無視されます。

呼び出しは、Nexthink Webインターフェイスに接続されているすべてのエンジンまたは指定されたエンジンのみに送信され、ターゲットエンジンからの応答を受信するとNexthink Webインターフェイスで戻されるか、指定されたタイムアウトが経過したときに戻されます。 Nexthink Webインターフェイスからの成功した応答が選択したデバイスにリモートアクションが実行されることを保証するものではありません（エンジン応答のコード一覧を参照してください）。

Finder からリモートアクション、デバイス、およびエンジンの UID を取得する

リモートアクションの UID を取得するには:

  1. Finderにリモートアクションを編集する権限を持つユーザーとしてログインします。

  2. 左側のメニューのリモートアクションセクションで目的のリモートアクションを見つけます。

  3. リモートアクション名を右クリックします。

  4. エクスポート > リモートアクション UID をクリップボードにコピー を選択します。

  5. リクエストエディタで、Ctrl+V を押して JSON ペイロードに UID を貼り付けます。

デバイスの UID を見つけるには、次のいずれかを使用します:

  • Finder: デバイスオブジェクトの UID フィールドを表示します。

  • NXQL: デバイスオブジェクトの device_uid フィールドを取得します。たとえば、

(select device_uid (from device))

特定のエンジンをターゲットにするには、各エンジンのデータベースの UID を List Engines API から取得します。

HTTP ヘッダー

リモートアクションのAPIにPOSTリクエストを送信し、JSONコンテンツと基本認証を指定する次のHTTPヘッダーを指定します：

Content-type: application/json

Authorization: Basic [base-64(user:password)]

[base-64(user:password)] を、リモートアクションのAPIへのアクセス権を持つNexthinkユーザーの資格情報（base-64エンコーディング）に置き換えてください。

応答

成功した応答

成功した場合、Act API v2 への呼び出しは、HTTP コード 200 とともに、対象となる各エンジンからの応答リストを返します。

名前
説明

databaseUid

ターゲットエンジンの識別子

code

  • ok

  • timeout

  • engine_error

  • not_connected

  • unknownエラーdatabaseUid

  • no_permissionユーザーはエンジンへの許可を持っていません

お問い合わせ詳細

エンジンからの追加のメッセージの可能性

エラー応答

失敗した場合、Act API v2 への呼び出しは、エラーの種類に応じた HTTP コードのエラー応答を返します。

名前
説明

code

エラーコードのいずれか:

HTTP コード

INVALID_REQUEST_JSON

400

INVALID_REQUEST_CONTENT

400

INTERNAL_ERROR

500

CONTENT_TYPE

400

ENCODING

400

NO_REMOTE_ACTION_UID

400

NO_DEVICES

400

TOO_MANY_DEVICES

400

INVALID_ACTION_UID

400

INVALID_DEVICE_UID

400

NO_PERMISSION

403

UNKNOWN_OR_DISABLED_REMOTE_ACTION

400

NO_MANUAL_EXECUTION

400

NO_ENGINES_TO_TARGET

403

error

エラーコードの説明。

例

すべてのエンジンをターゲットにする

すべてのエンジンをターゲットにしたリクエストとその応答のJSON形式の例。

一つのエンジンをターゲットにする

一つのエンジンをターゲットにしたリクエストとその応答のJSON形式の例。

エラー応答

手動実行が無効なためにエラーを返すリクエストの例。

関連タスク

関連するリファレンス

Last updated

Was this helpful?