サービス/API Thinklet

Last updated 27 days ago

Was this helpful?

サービス/API Thinkletは、次のコネクタ認証情報タイプをサポートしています:

ベーシック

ベアラー

OAuth 2.0 - クライアント認証情報

OAuth 2.0 - 認可コード

サービス/API Thinkletは外部の公開APIにRESTコールを行います。追加の情報を取得したり、アクションの実行をリクエストするために使用します。

サービス/API Thinkletは次の呼び出し方法をサポートしています:

GET
POST
PATCH
PUT
DELETE

サービス/API Thinkletのサポートされるペイロードと応答はJSONフォーマットです。

名前: サービス/API Thinkletのためのユニークな名前を入力してください。
ID: システムは名前に基づいてIDを自動的に生成します。
説明 (オプション): Thinkletの目的とその機能を説明してください。この情報は、ワークフロー内であまり知られていない他のユーザーにとって役立ちます。
資格情報: 統合のための接続認証情報を選択してください。まず、管理モジュールのコネクタ認証情報ページでそれを設定する必要があります。詳細については、コネクタ認証情報ドキュメントを参照してください。
リクエストメソッド: リクエスト接続方法を選択してください。
リソース: 接続のエンドポイントを入力してください。
ペイロード: 外部システムに送信されるJSONペイロードを入力してください。

APIコールからデータを収集

サービス/API Thinkletは、外部システムへの呼び出しから得られた応答のデータを読み取ることができます。

最大5つの出力をサポートしています。

応答を待っているとき、サービス\API Thinkletは外部システムからの応答を最大10秒間待ち、それ以上経過した場合、呼び出しは失敗したと見なされます。

応答を受信した場合、外部システムから受信した応答の総サイズは、出力が設定されているかどうかに関わらず2MBを超えないこととされます。

これらの出力を設定するには:

出力を追加をクリックします。
名前: コンディションやThinklet入力で参照するための名前を入力してください。
JSONパス: システムが受け取ることを期待するデータのJSONパスを追加します。このパスは常に**$.**で始まるべきで、データへのパスはピリオドで区切られます。たとえば、ServiceNowのインシデント番号を取得するには:
```
$.result.number
```

JSONパス出力の最大サイズは30KBまたは3840文字です。

ペイロードにデータベースおよびワークフロー値を使用する

ワークフローの実行中に収集したユーザーおよびデバイスのデータを、リソースおよびペイロードフィールドで参照します。

一般フォーマット:

データを二重中括弧内に参照を含めます:

{{}}

Nexthinkデータベース属性を使用してServiceNowにペイロードを送信する例:

"cmdb_ci": "{{nx.device.name}}“

システム値の形式:

システム値は、現在のワークフロー実行への参照を提供するために使用できます。この方法は、ワークフローがサードパーティシステムがアクションを実行するのを待ち、その後ワークフローを進行させるために呼び出しを行う必要があるケースで役立ちます。

システム値は常にsys.workflowで始まります。

これらの値のリストを以下に示します。

sys.workflow.executionId: 現在実行中のワークフローの実行IDへの参照です。
sys.workflow.workflowId: 実行している特定のワークフローデザインへの参照です。

これらの値が使われるMoveworksチャットボットとの統合における例を以下に示します。この値は、チャットボットが後でワークフローを進行させるために使用されます。

{
    "メッセージ": " Hello, {{nx.user.ad.fullname}}様、重要なドライバの更新が欠落しており、パフォーマンスに影響を与えている可能性があります",
    "受取人": [
        {{nx.user.ad.email_address}}
    ],
    "コンテキスト": {
        "スロット": {
            "executionid": "{{sys.workflow.executionId}}",
            "workflowid": "{{sys.workflow.workflowId}}"
        }
    }
}

Thinklet値の形式:

ワークフロー内の他のThinkletからの出力を参照する際に、以下のフォーマットを使用します:

{{thinkletID.result.outputs.outputid}}

以前のサービス/API Thinkletからのデータを含むServiceNowインシデント更新のリソースの例:

api/now/table/incident/{{log_service_now_ticket.result.outputs.sys_id}}

データベース値の形式:

データ属性を取得する際、デバイスとユーザーオブジェクトからデータを収集できます。オブジェクトのデータは、ワークフロー実行が現在対処しているデバイスまたはユーザーに基づきます。

このデータにアクセスするフォーマットは次のとおりです:

{{nx.object.fieldname}}

デバイス属性を参照する例:

{{nx.device.ad_site}}

ユーザー属性を参照する例:

{{nx.user.ad.email_address}}

サポートされている属性のリストは、NQL データモデルのデバイスおよびユーザーセクションを参照し、フィールド列に含まれる値をフィールド名として使用してください。