Rest Api Action

Rest Api Action icon

RESTful API呼び出しを同期的に処理します。このアクションは、システムがさらに高い負荷を処理できるようにします。これは、API呼び出しの本文とヘッダーの両方を返します。これにより、スクリプトのテストとデバッグが容易になります。

REST APIオプションを含むスクリプトをテストし、レスポンス情報を表示するには、スクリプトを実行する必要があります。Start with Traceオプションを使用してスクリプトを実行します。

SNIPPETアクションで GetRestProxy関数を使用して、同期的なREST API呼び出しを行うこともできます。このオプションは、REST APIアクションほど負荷が高くない。

Dependencies

このアクションの使用には制限があります。一方が他方に影響を与えないように、事業単位閉じた テクニカルサポート、請求、およびCXone環境のグローバル設定の管理に使用される高レベルの組織グループレベルで制限が課されます。プラットフォーム内の制限は以下のとおりです：

  • 応答形式：JSON応答形式のみがサポートされます。
  • 失敗時の再試行：応答を返す前に失敗メッセージを受信した場合、アクションハンドラは自動的に2回試行します。
  • タイムアウト：タイムアウトの値はリクエストの中で指定します。90秒を超える値は設定できません。
  • 最大応答サイズ：最大応答サイズは32 KBです。これは、既存のSnippet機能と一致しています。
  • スロットル制限：スロットル制限は以下の2つのパラメーターで定義されます。
    • 最大同時リクエスト数：デフォルトで最大100の同時リクエストが可能です。この制限はCXoneのすべてのお客様に適用されます。つまり、100回の同時リクエストで、既存のSnippet機能よりもはるかに高いスループットを実現できます。100を超える同時リクエスト数が必要な場合は、CXoneアカウント担当者に相談して、事業単位の制限を増やしてください。特別な承認が必要です。
    • キュー内カウント：リクエストが上限を超えると、余分なリクエストは処理キューに入ります。リクエストが上限を下回ると、キューにあるリクエストが処理されます。
  • 遮断器：指定したURLがダウンしているか到達できない場合、リクエストの失敗回数があまりに多くなります。これが発生すると、CXoneは、一定期間、REST APIアクションからのすべてのURLのリクエスト実行をバックオフ(つまり削減)します。これにより、指定したURLは障害から回復できます。以下に制限を示します。
    • バックオフ時間または休憩時間：失敗率に達すると、REST APIアクションからのリクエストは30秒間実行されなくなります。
    • 最小スループット：1秒間に100件のリクエスト。事業単位が最小数のリクエストを実行していない場合、失敗していてもリクエストを実行し続けます。
    • 失敗率：30秒間にリクエストの50%が失敗した場合、リクエストは次の30秒間実行されません。30秒はローリングウィンドウです。

Input Properties

これらのプロパティは、アクションが実行時に使用するデータを定義します。

プロパティ

説明

を追加

スクリプト内でこのアクションを一意に識別できる、短いフレーズを入力します。アクションアイコンにカーソルを合わせるとキャプションが表示されます。The default is the action name.

Verb

GET、PUT、POST、DELETE、PATCHなどの基本的なRESTアクションをサポートします。
Parameters

クエリパラメータを指定したり、データを投稿したりする機能をサポートします。あらゆる種類の JSON - Jobject 、 Jarray 、 Jtoken が受け入れられる必要があります。現在、アクションでは JSON を 1 行で提供する必要があります。JSONを含む文字列からの変数置換、またはasjson()関数を使用したダイナミックデータ型のJSONへの変換がサポートされています。前のREST APIアクションからの出力変数 resultSet(out)をこのプロパティに渡すこともできます。
Headers

カスタムヘッダーを追加して顧客認証（ベアラートークンなど）を可能にする機能をサポートします。JSON形式で表現されたキーと値のペアが受け入れられます。このアクションでは、JSONを1行で指定する必要があります。JSONを含む文字列からの変数置換、またはasjson()関数を使用したダイナミックデータ型のJSONへの変換がサポートされています。前のREST APIアクションからの出力変数resultSet(out)をこのプロパティに渡すこともできます。

重要カスタムURLエンドポイントで異なるヘッダーが必要な場合は、このプロパティで指定する必要があります。既存のSnippetアクションと機能を同等に保つために、CXoneは次のヘッダーを追加します。

{"Accept":"application/json", "Content-Type" :"application/x-www-form-urlencoded"}

Command

唯一のオプションはMakeRestRequestで、Snippetactionで使用する場合と同じように機能します。将来の開発では、Snippetアクションが提供する追加コマンドが提供される可能性があります。

TimeOutInMilliSeconds

REST 呼び出しのタイムアウトを指定して受け入れることができます。90 秒 (90000 ミリ秒) 未満である必要があります。タイムアウトを指定しない場合、デフォルトは10秒(10000ミリ秒)です。
Service Address

GETのクエリパラメータを指定する機能を含め、カスタムURLを指定できます。変数置換もサポートされています。

出力プロパティ

これらのプロパティには、実行したアクションから返されたデータを保持する変数が含まれています。これらはアクションが完了したときに参照・使用することができます。

プロパティ

説明

resultSet(out)

サービスの住所で指定されたAPIから返される情報を含むプロパティ。Studioトレースウィンドウでは、表示のためにDynamic Objectとなっています。必要に応じて、このresultSetをそのままヘダーとパラメーターに渡すこともできます。

errorArgList(out)

エラー条件には、互換性のためにRESTプロキシのようなオブジェクトがあります。DynamicDataタイプをサポートします。

結果ブランチ条件

結果の分岐条件を使用すると、アクションが実行されたときにさまざまな結果を処理できるように、スクリプトにブランチを作成できます。

状態

説明
Throttle

短期間で実行されるリクエストが多すぎる場合に使用されるパス。詳細については、以下の制限を参照してください。
InvalidInput

無効な入力が見つかった場合、またはタイムアウトエラーが発生した場合にとられるパス。スクリプトを保存すると、すべてのパラメーターが検証されます。
Failure

リクエストのNICE CXoneアプリケーション実行中にエラーまたは例外が発生したときに取られるパス。
Error

リモートカスタマーエンドポイントがhttpエラーコードを返すときに使用されるパス。
Default

90秒以内に応答がない場合にたどるパス。
Success

アクションがエラーなしで完了し、API呼び出しまたはデータの戻りが成功した場合に実行されるパス(2xx応答コード)。

Other Options

Snippetactionで現在完了している外部RESTful APIリクエストを置き換えることができます。