RESTタスクのパラメータの表示および管理
パラメータは、RESTタスクの様々な部分に含めることができます。
パラメータ化できるRESTタスクの一部は次のとおりです。
- RESTの実行URL、ポーリングURLまたは終了URLの1つ以上のセクション。データ統合では、URLのパラメータ化された変数セクションはURLパラメータと呼ばれます。「HTTPメソッド、URLおよびURLパラメータの構成」を参照してください。
- リクエストのヘッダーの値。ヘッダー値のパラメータ化を参照してください。
- POSTまたはPUTリクエストのリクエスト本文全体。リクエスト本文のパラメータ化を参照してください。
- RESTコールの正常完了の基準を決定する成功条件。成功条件のパラメータ化を参照してください。
- ポーリングを停止するか続行するかを決定するポーリング条件(ポーリング・リクエストから返されるレスポンスに対して記述される)。ポーリング条件のパラメータ化を参照してください。
RESTタスクの一部がパラメータ化されている場合、そのパラメータは、その1つのタスクのスコープでのみ定義および使用されます。
1つのRESTタスクのスコープで追加されたすべてのパラメータ(タスクで追加されて使用されていないパラメータを含む)を表示および管理します。
RESTタスクのすべてのパラメータの表示
RESTタスクを開き、そのタスクで作成されたパラメータと割り当てられたパラメータのリストを表示します。割り当てられていないパラメータもリストに表示されます。
パラメータの追加
スカラー、JSONおよび式のパラメータをRESTタスクのスコープに追加して、同じRESTタスク内のパラメータ化された要素を参照することができます。
- タスクを編集するプロジェクトまたはフォルダを開きます。
- プロジェクトまたはフォルダの詳細ページで、「タスク」をクリックします。
- タスク・リストで、タスクのアクション・メニューから「詳細の表示」を選択します。
- 「RESTタスク」ページの「パラメータ」セクションで、「構成」をクリックします。
- 「RESTタスク・パラメータ」ページで、「パラメータの追加」をクリックし、追加するパラメータの型を選択します。
-
「パラメータの追加」パネルでは、次のパラメータの型を定義できます。
- スカラー: 従来の名前と値のペアのパラメータを追加します。一意の識別子、データ型およびデフォルト値を指定します。
- JSON: JSONデータ型のパラメータを追加します。一意の識別子と、有効なJSONを値として指定します。
- 式: タイプが式のパラメータを追加します。一意の識別子を指定してから、条件ビルダーを使用して式を記述します。
- 「追加」をクリックします。
- 「RESTタスク・パラメータ」ページの「完了」をクリックします。
RESTタスク・パラメータの編集
パラメータの説明、データ型および値を編集できます。
RESTタスク・パラメータの削除
パラメータを削除できるのは、そのパラメータがRESTタスクで使用されていない場合のみです。
「RESTタスク・パラメータ」ページの「使用先」列は、タスクでパラメータが使用されている場所を示します。