HTTPメソッド、URLおよびURLパラメータの構成

RESTリクエストが実行するためのHTTPメソッドとURLを指定し、RESTタスクのURLパラメータを構成します。

オプションのポーリングURLおよび終了URLを入力(または編集)する際には、次の手順も使用できます。

HTTPメソッドおよびURLの構成

このメソッドは、GETやPOSTなどの標準HTTPメソッドです。URLは、RESTリクエストでアクセスするリソースのREST APIエンドポイントです。

たとえば、次のRESTエンドポイントは、ワークスペースID finance123のデータ・アセットをリストします:

http://myserver.com:8081/workspaces/finance123/dataAssets

URLには、構文${}を使用してパラメータを含めることができます。たとえば、次のRESTエンドポイントは、URLの変数セクションでサーバー・ホストとワークスペースIDを指定するパラメータ構文を使用して、ワークスペース内のデータ・アセットをリストします。

http://${myserver}:8081/workspaces/${workspaceId}/dataAssets

パラメータ構文を使用してURLの一部を指定すると、それらの部分がRESTタスクの文字列URLパラメータに変換されます。各URLパラメータにはデフォルト値を割り当てる必要があります。

タスクの実行時に、これらのURLパラメータの値を変更できます。たとえば、実行時に、サーバーとワークスペースIDに異なる値を指定できます。

次の手順を使用して、オプションのポーリングURLおよび終了URLを入力(または編集)することもできます。

HTTPメソッドおよびURLを構成するには:

「REST API詳細の構成」ページの「実行詳細の定義」ステップの「HTTPメソッド」で、このRESTタスクのURLで使用するHTTPメソッドを選択します。

オプションのポーリングURLおよび終了URLを構成するには、「完了基準の指定」ステップに移動し、「ポーリング」または「終了」タブをクリックしてHTTPメソッドを選択します。「Polling」および「Termination」タブは、「Configure a polling and terminate condition for a no-wait REST call」チェック・ボックスが選択されている場合にのみ表示されます。
「URL」フィールドに完全なURLを入力し、[Enter]を押します。
URLの一部に${}パラメータ構文を使用すると、それらの部分はRESTタスクのURLパラメータに変換されます。
「URLパラメータ」フィールドの下の表が、パラメータ化された部分を含むように更新されます。各URLパラメータのデフォルトのデータ型はStringです。
各URLパラメータにデフォルト値を割り当てるには、URLパラメータの構成を参照してください。データ型を変更し、各パラメータに説明を追加できます。
パラメータ構文を追加または削除してURLを編集すると、いつでもそれに応じてURLパラメータ表が更新されます。

URLパラメータの構成

URLを入力(または編集)して「入力」をクリックすると、パラメータ構文${}を使用するURL内のセクションが、RESTタスクのURLパラメータに変換されます。

新たに追加されるすべてのURLパラメータのデフォルトのデータ型はStringです。「URLパラメータ」タブでは、RESTタスク・パラメータのデフォルト値を追加でき、必要に応じてパラメータ・データ型を変更することもできます。

次の手順を使用して、オプションのポーリングURLおよび終了URLのURLパラメータを編集することもできます。

URLパラメータを構成するには:

「REST API詳細の構成」ページの「実行詳細の定義」ステップで、「URLパラメータ」タブをクリックします。

オプションのポーリングおよび終了URLのURLパラメータを構成するには、「完了基準の指定」ステップに移動し、「ポーリング」または「終了」タブをクリックして、「URLパラメータ」をクリックします。「Polling」および「Termination」タブは、「Configure a polling and terminate condition for a no-wait REST call」チェック・ボックスが選択されている場合にのみ表示されます。
表内の新規追加URLパラメータの行で、アクション・メニュー()から「編集」を選択します。
「パラメータの編集」パネルの「識別子」読取り専用フィールドに、パラメータ化されたURL変数セクションのRESTタスク・パラメータ名が表示されます。
1. パラメータのオプションの説明を入力します。
2. 「データ型」メニューを使用して、パラメータのデータ型を変更します。
3. 「値」フィールドに、パラメータのデフォルト値を入力します。
4. 「保存」をクリックします。
  表のURLパラメータが更新されます。
構成したパラメータのデフォルト値を使用するURLを表示または非表示にするには、「プレビューURLの表示」または「プレビューURLの非表示」をクリックします。