完了基準の指定

REST実行の正常完了の基準を決定する条件を指定します。

APIによって呼び出される操作が短時間実行するか長時間実行するかには関係なく、すべてのREST呼出しを完了させるために成功条件が必要です。

ポーリングを使用して、長時間実行操作でのREST呼出しの完了を定義するには、ポーリングを使用した完了基準の指定も参照してください。

基本的な文字列関数および演算子関数が、成功条件とポーリング条件でサポートされています。

成功条件またはポーリング条件の式には、次の項に示す関数のみを含めることができます。JSON構造の値を抽出するには、json_path関数を使用します。

基本演算	`+` `-` `*` `.`など
基本ブール	`AND` `OR` `NOT`
基本比較	`>` `<` `!=`
基本null	`IS NULL` `IS NOT NULL` `NVL`
基本文字列	`CONCAT` `LENGTH` `UPPER` `LOWER`
基本日付/時間	`DATE_ADD`
`json_path`関数	JSONPath構文の要素については、次を参照してください: `http://goessner.net/articles/JsonPath/` たとえば、次のレスポンスから現在のステータス値を取得するには、構文`$.status.current-status`を使用します `{ "processName": "createCustomer", "region" : "usa-1", "status" : { "current-status": "accepted", "id" : "usa1h3l4ewrt0989" }`

完了基準(成功条件)の指定

RESTタスクの成功条件は、REST APIコールの正常完了を決定する式です。成功条件が満たされると、ポーリングが停止します。

デフォルトでは、データ統合によってRESTタスクの成功条件が提供されます。デフォルトの成功条件は、200以上300未満のHTTPステータス・コードです。次の式で記述されます:

SYS.RESPONSE_STATUS >= 200 AND SYS.RESPONSE_STATUS < 300

成功条件の式は、実行ステップで定義されたRESTリクエストから受信したJSONレスポンスの出力を参照します。

デフォルトの成功条件を使用することも、システム出力またはレスポンスから抽出されたJSONプロパティ値を使用して独自の条件式を記述することもできます。

成功条件を編集するには:

「REST API詳細の構成」ページで、「完了基準の指定」ステップに移動します。
REST APIが長時間実行操作を起動する場合は、「待機なしRESTコールのポーリングおよび終了条件を構成します」チェック・ボックスを選択します。
「条件」ブロックで、「成功条件」の横にある「編集」をクリックします。
「成功条件の編集」パネルで、RESTリクエストのレスポンスの出力を使用する式を入力します。

条件式には、次の要素を含めることができます。
- 受信: 受信するレスポンス出力(たとえば、SYS.RESPONSE_PAYLOAD_JSON、SYS.RESPONSE_HEADERS_JSON、SYS.RESPONSE_STATUS)を使用できます。
- パラメータ: このRESTタスクのスコープに定義されている任意のパラメータを使用できます。RESTタスクのパラメータの表示および管理を参照してください。
- 関数: データ統合の基本的な文字列関数と演算子関数を使用できます。文字列関数に含まれるjson_pathを使用すると、次の形式で、JSONPath構文要素を使用するレスポンスからプロパティ値を抽出できます: json_path(json_string, json_filter_path)
  
  例: json_path(SYS.RESPONSE_PAYLOAD, '$.@STATUS')
成功条件式ではすべての関数がサポートされるわけではありません。こちらのサポート対象リストを参照してください。

(長時間操作の場合)「非待機RESTコールのポーリングおよび終了条件を構成します」チェック・ボックスを選択した場合、ポーリング・リクエストのレスポンスに書き込まれる式が成功条件になります。実行ステップのAPIレスポンスを使用する式を作成し、その後、名前を付けた式を組み込んで成功条件を作成できます。
タスク・パラメータを成功条件に割り当てるには、「パラメータの割当て」をクリックします。成功条件のパラメータ化を参照してください。

成功条件のパラメータ化

タスク・パラメータをRESTタスクの成功条件に割り当てることができます。

次の手順を使用して、ポーリング条件をパラメータ化することもできます。

条件をパラメータ化するには:

「REST API詳細の構成」ページで、「完了基準の指定」ステップに移動します。

ポーリング条件をパラメータ化するには、「完了基準の指定」ステップに移動し、「ポーリング」タブをクリックします。「ポーリング」タブは、「待機なしRESTコールのポーリングおよび終了条件の構成」チェック・ボックスが選択されている場合にのみ表示されることに注意してください。
「条件」ブロックで、条件の横にある「パラメータの割当て」をクリックします。
「パラメータの追加」パネルで、「識別子」フィールドにパラメータの名前を入力するか、デフォルト値を使用します。

パラメータ名はRESTタスク内で一意である必要があります。タスク内のパラメータの現在のリストを確認する方法は、RESTタスク内のすべてのパラメータの表示を参照してください。
(オプション)他のユーザーにパラメータの目的がわかるように、説明を入力します。
パラメータの「タイプ」は「式」です。変更することはできません。
条件ビルダーで、このパラメータのデフォルトの条件式を設定します。このデフォルトの条件は、後で(設計時または実行時に)値を変更しないかぎり、実行時に使用されます。

条件式には、次の要素を含めることができます。
- 受信: 受信レスポンス出力(SYS.RESPONSE_PAYLOAD_JSON、SYS.RESPONSE_HEADERS_JSON、SYS.RESPONSE_STATUSなど)。
- パラメータ: このRESTタスクのスコープで定義されているパラメータ。RESTタスクのパラメータの表示および管理を参照してください。
- ファンクション: データ統合ファンクション。文字列関数に含まれるjson_pathを使用すると、次の形式で、JSONPath構文要素を使用するレスポンスからプロパティ値を抽出できます: json_path(json_string, json_filter_path)
  
  例: json_path(SYS.RESPONSE_PAYLOAD, '$.@STATUS')
「追加」をクリックします。
パラメータ名が条件の横に追加されます。

成功条件パラメータの編集

成功条件のタスク・パラメータの説明およびデフォルト値を変更できます。

次の手順を使用して、ポーリング条件パラメータを編集することもできます。

パラメータ化された条件を編集するには:

「REST API詳細の構成」ページで、「完了基準の指定」ステップに移動します。

パラメータ化されたポーリング条件を編集するには、「完了基準の指定」ステップに移動し、「ポーリング」タブをクリックします。「ポーリング」タブは、「待機なしRESTコールのポーリングおよび終了条件の構成」チェック・ボックスが選択されている場合にのみ表示されることに注意してください。
「条件」ブロックで、「パラメータの編集」をクリックします。
「パラメータの編集」パネルで、説明と条件式のみを編集します。識別子(名前)およびデータ型は変更できません。
「変更の保存」をクリックします。

成功条件パラメータの削除

条件パラメータを削除すると、RESTタスクに指定された成功条件とパラメータとの関連付けのみが削除されます。

次の手順を使用して、ポーリング条件パラメータを削除することもできます。

条件からパラメータの割当を解除するには:

「REST API詳細の構成」ページで、「完了基準の指定」ステップに移動します。

ポーリング条件からパラメータの割当てを解除するには、「完了基準の指定」ステップに移動し、「ポーリング」タブをクリックします。「ポーリング」タブは、「待機なしRESTコールのポーリングおよび終了条件の構成」チェック・ボックスが選択されている場合にのみ表示されることに注意してください。
「条件」ブロックで、「パラメータの削除」をクリックします。
「パラメータの削除」ダイアログ・ボックスで、「削除」をクリックします。

パラメータは条件から割り当て解除されます。パラメータに割り当てられていた条件式がデフォルトの条件になります。

ノート

パラメータはRESTタスクから削除されません。パラメータを削除するには、RESTタスク・パラメータの削除を参照してください。

Oracle Cloud Infrastructureドキュメント

完了基準の指定