Rest APIアクション

Rest APIアクションアイコン

RESTful API呼び出しを非同期で処理して、高負荷をより適切に処理します。このアクションでは、ブロックスレッドが必要ないため、システムはより高い負荷を処理できます(現在、REST APIアクションの呼び出しは、ブロックスレッドを必要とするスニペットアクションを使用して実行されます)。

プロパティ

プロパティ 細部
動詞 GET、PUT、POST、DELETE、PATCHなどの基本的なRESTアクションをサポートします。
パラメータ クエリパラメータを指定したり、データを投稿したりする機能をサポートします。あらゆる種類の JSON - Jobject 、 Jarray 、 Jtoken が受け入れられる必要があります。現在、アクションでは JSON を 1 行で提供する必要があります。Json を含む文字列からの変数置換、または .asjson()メソッドを使用した動的データ型の json への変換がサポートされています。前のREST APIアクションからの出力変数resultSet(out)をこのプロパティに渡すこともできます。
ヘッダー

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

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

{"承認":"application/json", "コンテンツタイプ" :"application/x-www-form-urlencoded"}

コマンド

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

TimeOutInMilliSeconds REST 呼び出しのタイムアウトを指定して受け入れることができます。90 秒 (90000 ミリ秒) 未満である必要があります。
サービスの住所 GETのクエリパラメータを指定する機能を含め、カスタムURLを指定できます。変数置換もサポートされています。

出力変数

変数 細部
resultSet(out) 組織で提供されているサービスアドレスのエンドポイントからの応答。Studioトレースウィンドウでは、表示のために動的オブジェクトとして表示されます。必要に応じて、このresultSetをそのままヘッダーとパラメーターに渡すこともできます。
errorArgList(out) エラー条件には、互換性のためにRESTプロキシのようなオブジェクトがあります。DynamicDataタイプをサポートします。

ブランチ

ブランチ 細部
OnThrottle 短期間で実行されるリクエストが多すぎる場合に使用されるパス。詳細については、以下の制限を参照してください。
OnInvalidInput 無効な入力が見つかった場合、またはタイムアウトエラーが発生した場合にとられるパス。スクリプトを保存すると、すべてのパラメーターが検証されます。
OnFailure リクエストのNICE CXoneapplication実行中にエラーまたは例外が発生したときに取られるパス。
OnError リモートカスタマーエンドポイントがhttpエラーコードを返すときに使用されるパス。
デフォルト 90 秒以内に応答が受信されなかった場合のパス。

制限事項

一方が他方に影響を与えないように、テナントレベルで制限が課されます。以下はplatform内の制限です:

  • 応答形式— JSON 応答形式のみがサポートされます。
  • 失敗時の再試行 —応答を返す前に失敗を受け取った場合、アクションハンドラは自動的に2回試行します。2xx以外のhttpステータスコードは再試行可能です。
  • タイムアウト —タイムアウトはリクエストでの指定どおりで、90秒を超えることはできません。
  • 最大応答サイズ —転送できる最大応答サイズは32 KBで、既存のスニペット機能と一致しています。
  • スロットル制限 —スロットル制限は2つのパラメーターで定義されます。
    • 最大同時リクエスト—既存のSnippet機能に従って、30の同時リクエストが許可されます。ただし、これらは非同期呼び出しです。 30で達成されるスループットは、既存のスニペット機能よりもはるかに大きくなります。
    • キューカウント—上記の最大同時リクエストに達すると、システムは5000リクエストをキューに入れます。同時実行に帯域幅があり、より多くの要求を処理できるようになるとすぐに選択されます。
  • 遮断器 —指定したURLがダウンしているか到達できない場合(リクエストで失敗が多すぎるなど)、 CXoneは指定したURLが障害から回復し、リクエストを正常に受信できるように、実行を一定期間バックオフ(削減)します。以下に制限を示します。
  • バックオフ時間または休憩時間 - 30秒。失敗率が達成されると、リクエストは30秒間実行されません。
  • 最小スループット — 100。テナントが最小数のリクエストを実行していない場合、リクエストが失敗しても、リクエストを実行しないように制限されません。
  • 故障率 — 50%。リクエストの50%が30秒間失敗した場合、リクエストは次の30秒間実行されません。30秒はローリングウィンドウです。

別のオプション

スニペットアクションで現在完了している外部RESTful APIリクエストを置き換えることができます。