完了基準の指定
REST実行の正常完了の基準を決定する条件を指定します。
APIによって呼び出される操作が短時間実行するか長時間実行するかには関係なく、すべてのREST呼出しを完了させるために成功条件が必要です。
ポーリングを使用して、長時間実行操作でのREST呼出しの完了を定義するには、ポーリングを使用した完了基準の指定も参照してください。
基本的な文字列関数および演算子関数が、成功条件とポーリング条件でサポートされています。
成功条件またはポーリング条件の式には、次の項に示す関数のみを含めることができます。JSON構造の値を抽出するには、json_path関数を使用します。
| 基本演算 |
|
| 基本ブール |
|
| 基本比較 |
|
| 基本null |
|
| 基本文字列 |
|
| 基本日付/時間 |
|
json_path関数 |
JSONPath構文の要素については、次を参照してください:
たとえば、次のレスポンスから現在のステータス値を取得するには、構文 |
RESTタスクの成功条件は、REST APIコールの正常完了を決定する式です。成功条件が満たされるとポーリングが停止します。
デフォルトでは、データ統合によってRESTタスクの成功条件が提供されます。デフォルトの成功条件は、200以上300未満のHTTPステータス・コードです。次の式で記述されます:
SYS.RESPONSE_STATUS >= 200 AND SYS.RESPONSE_STATUS < 300
成功条件の式は、実行ステップで定義されたRESTリクエストから受信したJSONレスポンスの出力を参照します。
デフォルトの成功条件を使用できます。または、システム出力またはレスポンスから抽出されたJSONプロパティ値を使用して条件式を記述できます。
成功条件を編集するには:
タスク・パラメータをRESTタスクの成功条件に割り当てることができます。
次の手順を使用して、ポーリング条件をパラメータ化することもできます。
条件をパラメータ化するには:
成功条件のタスク・パラメータの説明およびデフォルト値を変更できます。
次の手順を使用して、ポーリング条件パラメータを編集することもできます。
パラメータ化された条件を編集するには:
条件パラメータを削除すると、RESTタスクに指定された成功条件とパラメータとの関連付けのみが削除されます。
次の手順を使用して、ポーリング条件パラメータを削除することもできます。
条件からパラメータの割当を解除するには: