Web リクエストの送信の追加および構成—Workflow Manager Server

[Web リクエストの送信] ステップでは、REST エンドポイントにリクエストを送信してデータを取得したり、更新情報を投稿したりすることができます。 Workflow Manager が ArcGIS Workflow Manager Server Advanced ロールでライセンス付与されている場合、REST エンドポイントのレスポンスをカスタム出力値として構成し、ファイルとして保存して、ジョブに添付することができます。カスタム出力値は、後続の REST 呼び出しのトークンを取得したり、ワークフローがたどるパスを決定したり、ワークフロー全体で他のステップの入力値として使用したりすることができます。

ステップが実行されると、ステップで定義された REST エンドポイントに Web リクエストが送信されます。

ステップは、[ステップの完了] ボタン Complete Step をクリックすることで完了できます。

ステップの構成

To configure the step, do the following:

注意:

セキュリティの脆弱性を低減するには、信頼できる Web ページや Web アプリに対してのみ [Web リクエストの送信] ステップを構成してください。

Create or edit a workflow diagram to access the Step Library panel.
[Web リクエストの送信] を [ステップのライブラリ] パネルからワークフローキャンバス上のステップの接続矢印にドラッグします。
Learn more about adding steps to a workflow diagram

The Step Details panel appears.
Provide a name for the step in the Step Name text box.
[引数] セクションで [編集] をクリックします。
[URL] ドロップダウン矢印をクリックし、送信するリクエストのタイプを選択します。
[URL] テキストボックスに REST エンドポイントの URL を入力します。
必要に応じて、次の構文を使用して URL にパス変数を追加します。
```
https://gisserver.domain.com/webadaptorname/apps/workflowmanager/:pathVariable/
```
パス変数が [パス変数] セクションに表示されます。
URL にパス変数を追加した場合は、[パス変数] セクションで各変数の値を入力します。
You can also use ArcGIS Arcade expressions to provide a dynamic value.
ヒント:
Click the This input supports Arcade Expressions button and choose an ArcGIS Arcade expression to add it to its associated text box.
必要に応じ、Web リクエストにクエリパラメーターを追加します。
1. [クエリパラメーター] セクションで [キーと値の追加] をクリックします。
2. [キー] テキストボックスにキーを入力します。
  You can also use ArcGIS Arcade expressions to provide a dynamic value.
3. [値] テキストボックスに値を入力します。
  You can also use ArcGIS Arcade expressions to provide a dynamic value.
4. [有効] チェックボックスはオンのままにしておきます。
5. キー値ペアをさらに追加するには、サブステップ a ～ d を繰り返します。
[認証] タブをクリックします。
REST エンドポイントの認証方法を選択し、必要に応じて認証情報を入力します。
注意:
ステップで入力する認証情報は暗号化されません。情報を保護するには、暗号化されたユーザー定義設定を追加して情報を格納し、動的なジョブプロパティを使用してステップ内で参照します。
1. [API キー] または [ベアラートークン] オプションを選択した場合は、必要に応じて、[または、エンドポイントからトークンを生成する] をクリックします。
  [エンドポイントからのトークンの生成] ダイアログボックスが表示されます。
2. トークン設定を構成して、Web リクエストのトークンを生成します。
必要に応じて、[ヘッダー] タブをクリックし、カスタムヘッダーのキー値ペアを Web リクエストに追加します。
1. [カスタムヘッダー] セクションで [キーと値の追加] をクリックします。
2. [キー] テキストボックスにキーを入力します。
  You can also use ArcGIS Arcade expressions to provide a dynamic value.
3. [値] テキストボックスに値を入力します。
  You can also use ArcGIS Arcade expressions to provide a dynamic value.
4. [有効] チェックボックスはオンのままにしておきます。
5. キー値ペアをさらに追加するには、サブステップ a ～ d を繰り返します。
必要に応じて、[本文] タブをクリックして、Web リクエストにデータを追加します。
リクエストの本文は、フォームデータのキー値ペア、URL エンコードされたキー値ペア、および JSON 形式またはプレーンテキスト形式の未加工データをサポートしています。
ヒント:
また、ArcGIS Arcade 式を使用して、ユーザー定義設定を取得したり、本文テキストに動的な値を入力したりすることもできます。
必要に応じて、ArcGIS Workflow Manager Server Advanced のライセンスが付与されている場合は、ステップの出力設定を構成することができます。
必要に応じて [テスト] タブをクリックし、[応答のテスト] をクリックして、構成済みのリクエストを送信し、その応答を表示します。
Web リクエストにジョブ固有の Arcade 式が含まれている場合、[ジョブ ID を含める] をオンにし、[ジョブ ID] テキストボックスにジョブ ID を入力して、リクエストの書式を適切に設定する必要があります。
[保存] をクリックして、[Web リクエストの構成] ダイアログボックスを閉じます。
Click the Options tab.
Configure Step Options as necessary.
- Manual—Run the step manually.
  - Optional—Allow the step to be finished without being run.
- Automatic—Run the step as soon as it becomes active.
  注意:
  If your workflow diagram is configured to automatically run a sequence of steps that includes the Evaluate Data Quality or the Run GP Service step, steps that attempt to run after the user token that started the sequence of steps expires will not run automatically. You must have a license for the ArcGIS Workflow Manager Server Advanced role to continue running the additional automated steps without manual intervention.
- Run on a Schedule—Run the step according to a schedule you set.
  Learn more about scheduling options
Optionally, provide help text for the step in the Step Help text box.
You can also use ArcGIS Arcade expressions to provide a dynamic value for the step help. If the step help contains plain text and Arcade expressions, you'll need to format the text as follows:
```
'For further assistance, please contact ' + JobCreator($Job) + '.'
```
Optionally, click the Style tab to change the shape and color of the step.
Optionally, click the About tab and provide a description for the step in the Step Description text box.
注意:
The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output.

トークン設定の構成

REST エンドポイントに認証用のトークンが必要な場合、次の手順を実行して、Web リクエストの認証に使用できるトークンを生成するよう Web リクエストの送信ステップを構成します。

[URL] ドロップダウン矢印をクリックし、送信するリクエストのタイプを選択します。
[URL] テキストボックスに REST エンドポイントの URL を入力します。
必要に応じ、Web リクエストにクエリパラメーターを追加します。
1. [クエリパラメーター] セクションで [キーと値の追加] をクリックします。
2. [キー] テキストボックスにキーを入力します。
  You can also use ArcGIS Arcade expressions to provide a dynamic value.
3. [値] テキストボックスに値を入力します。
  You can also use ArcGIS Arcade expressions to provide a dynamic value.
4. [有効] チェックボックスはオンのままにしておきます。
5. キー値ペアをさらに追加するには、サブステップ a ～ d を繰り返します。
必要に応じて、[ヘッダー] タブをクリックし、カスタムヘッダーのキー値ペアを Web リクエストに追加します。
1. [カスタムヘッダー] セクションで [キーと値の追加] をクリックします。
2. [キー] テキストボックスにキーを入力します。
  You can also use ArcGIS Arcade expressions to provide a dynamic value.
3. [値] テキストボックスに値を入力します。
  You can also use ArcGIS Arcade expressions to provide a dynamic value.
4. [有効] チェックボックスはオンのままにしておきます。
5. キー値ペアをさらに追加するには、サブステップ a ～ d を繰り返します。
必要に応じて、[本文] タブをクリックして、Web リクエストにデータを追加します。
リクエストの本文は、フォームデータのキー値ペア、URL エンコードされたキー値ペア、および JSON 形式またはプレーンテキスト形式の未加工データをサポートしています。
ヒント:
また、ArcGIS Arcade 式を使用して、ユーザー定義設定を取得したり、本文テキストに動的な値を入力したりすることもできます。
[トークン] タブをクリックします。
[トークン] セクションで [モードのテスト] 切り替えボタンをクリックします。

REST エンドポイントのレスポンスの例を [サンプルレスポンス] テキストボックスに貼り付けます。

JSON 形式によるレスポンスの例:

{"access_token": "12345abcde",
"expires_in":7199,
"spatialReference": {
  "wkid": 4326,
  "latestWkid": 4326
},
"locations": [
  {
    "name": "380 New York Street",
    "extent": {
      "xmin": -117.196701,
      "ymin": 34.055489
    }
  }
]}

[出力値] テキストボックスにトークンの名前を入力します。
これは、生成されたトークンを参照するステップで使用される名前です。
応答を解析し生成されたトークンを返す JSONPath 式をドット記法またはブラケット記法で入力します。
ドット記法による JSONPath の例:
```
$.access_token
```
ブラケット記法による JSONPath の例:
```
$['access_token']
```
値は [サンプル結果] 列に表示されます。
[ステップの構成に戻る] をクリックして、ステップの構成を続行します。

出力設定の構成

ライセンス:

This functionality requires a license for the ArcGIS Workflow Manager Server Advanced role.

ArcGIS Workflow Manager Server Advanced ロールでは、REST エンドポイントのレスポンスをファイルとして保存し、ジョブに添付したり、カスタム出力値として構成したりすることができます。出力値は、ワークフローがたどるパスを決定したり、ワークフロー全体で他のステップの入力値として使用したりすることができます。ステップに出力値が構成されていない場合は、HTTP ステータスコードがステップの出力値として格納されます。ステップの出力設定を構成するには、以下を実行します。

[Web リクエストの構成] ダイアログボックスで [出力] タブをクリックします。
[Web リクエストの構成] ダイアログボックスが使用できない場合は、ワークフローキャンバス上で [Web リクエストの送信] ステップをクリックし、[ステップの詳細] パネルの [引数] セクションで [編集] をクリックします。
必要に応じて、[レスポンスの添付] セクションの [有効] 切り替えボタンをクリックし、REST エンドポイントのレスポンスをファイルとして保存して、ジョブに添付します。
必要に応じて、次の手順を実行し、添付ファイル名と格納先のフォルダーを構成します。
1. 添付ファイルが格納されるフォルダーの名前を [フォルダー名] テキストボックスに入力します。
  フォルダー名にファイルシステムパスまたは特殊文字を含めることはできません。フォルダー名が入力されていない場合、[General] という名前のフォルダーが自動的に作成されます。
  注意:
  フォルダーは、ワークフローアイテム内に含まれるため、ファイルシステムパスではありません。
2. 次の [添付ファイル名] オプションのうちの 1 つを選択します。
  - [自動生成] - 構文 (<StepName>_<RunDate>_<RunTime>) に従って、添付ファイル名を自動的に付与します。
  - [カスタム] - カスタムの添付ファイル名を入力できます。
必要に応じて、次の手順を実行し、REST エンドポイントのレスポンスに対するカスタム出力値を構成します。
1. [出力値] セクションの [モードのテスト] 切り替えボタンをクリックします。
2. REST エンドポイントのレスポンスの例を [サンプルレスポンス] テキストボックスに貼り付けます。
  JSON 形式によるレスポンスの例:
  {"access_token": "", "expires_in":7199, "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "locations": [ { "name": "380 New York Street", "extent": { "xmin": -117.196701, "ymin": 34.055489 } } ]}
3. [出力とパスの追加] をクリックします。
4. [出力値] テキストボックスに出力値の名前を入力します。
  これは、カスタム出力値の取得に使用される値の名前です。
5. [抽出パス] テキストボックスに格納する値の JSONPath 式をドット記法またはブラケット記法で入力します。
  ドット記法による JSONPath の例:
  $.locations.0.name
  ブラケット記法による JSONPath の例:
  $['locations'][0]['name']
  値は [サンプル結果] 列に表示されます。
6. 必要に応じて、サブステップ c ～ e を繰り返し、さらにカスタム出力値を追加します。
[保存] をクリックして、[Web リクエストの構成] ダイアログボックスを閉じます。

Return value

When the step is completed, its return value is stored to indicate the result of the step. The return value can be immediately evaluated using paths to determine the next steps in the workflow. You can also retrieve the return value for completed steps throughout the workflow using ArcGIS Arcade expressions. The following table lists the step's return values:


Return values	Description
S000001	The step completed successfully.
F000001	The step failed to complete successfully.

出力値

ライセンス:

This functionality requires a license for the ArcGIS Workflow Manager Server Advanced role.

When the step is completed, its output value is stored and can be used to determine the path the workflow follows or be used as inputs for other steps throughout the workflow. The following table shows the step's output value:


出力	説明
ステータス	ステップに出力値が構成されていない場合は、HTTP レスポンスコードを返します。
<CustomOutputValue>	ステップに構成したカスタム出力値を返します。

ステップの構成

注意:

ヒント:

注意:

ヒント:

注意:

注意:

トークン設定の構成

ヒント:

出力設定の構成

ライセンス:

注意:

Return value

出力値

ライセンス:

関連トピック

このトピックの内容