1. Homepage
  2. RPA Builder (6.0)
  3. Toolbox
  4. Network

  5. REST Call

REST Call

REST Call アクションステップ​を使用すると、簡単な方法でデータをサーバーから直接取得し、必要な情報を収集することができます。

必要に応じてエンドポイントを設定し、パラメーターまたはプロセス変数をコールに割り当てることができます。これにより、あらゆる REST インターフェースに柔軟に対処できます。JSON 形式 (または XML) の応答は、残りのプロセス実行中にソース変数として使用できます。

プロキシを介した REST Call

プロキシサーバーを介して REST Call を実行することもできます。これを行うために、REST Call アクションステップでは、必要な情報がネットワーク設定から自動的に取得されます (適切な設定が定義されている場合)。

ネットワーク設定は、Workflow Initialization ブロックにある Settings アクションステップで確認できます。

プロパティ

REST Call 設定

Base Url (ベース URL)​ ウィザードで入力されたエンドポイントが表示されます。

Json Path (Json パス)​ $.access_token などの JsonPath 式が表示されます。

Method Type (メソッド種別)​ REST ガイドラインでは、サーバーへの特定の種別のコールには特定の HTTP メソッドの使用が推奨されています。

Parse Type (解析種別)​ JsonPath と XPath のいずれかを選択できます。

どちらの種別においても、特別なスクリプトを使用することなく必要な情報を正確に抽出できるといった大きな利点があります。これにより、目的の結果にすぐにアクセスできるため、以降の処理が簡略化されます。

Json Query​ アクションステップを使用すると、Json オブジェクトから個々の値を読み取ることができるため、結果をさらに指定することができます。

Request body (リクエストボディ)​ 送信する内容を表示できます。

Request Body Type (リクエストボディ種別)​ ​[JSON]​ と ​[Form URL encoded (URL エンコードされたフォーム)]​ のいずれかを選択できます。

Url Extension (URL 拡張)​ リソースを一意に識別するパスパラメーター。

XPath​ /root/access_token/text() などの Xpath 表現が表示されます。

インバウンド変数

Base Url (ベース URL)​ ウィザードで入力されたエンドポイントが表示されます。

Url Extension (URL 拡張)​ リソースを一意に識別するパスパラメーター。

Json Path Expression (Json パス表現)​ $.access_token などの JsonPath 式が表示されます。

XPath Expression (XPath 式)​ /root/access_token/text() などの Xpath 表現が表示されます。

アウトバウンド変数

IsSuccessful​ (boolean (ブール)) REST Call が成功したかどうかを示します。

ResponseBody​ (string (文字列)) 要求された情報が文字列として返されます。

FirstItem​ (array (配列)) 配列の最初の要素が文字列として出力されます。

Status (状況)​ (integer (整数)) HTTP 状況コードが表示されます。OK の場合は 200 です。たとえば、要求が正常に処理され、結果が回答に転送された場合です。

ArrayCount​ 返された配列の要素の数を示します。

ウィザード

ウィザードは ​[Settings (設定)]​ と ​[Parameters (パラメーター)]​ の領域に分割されます。

[Settings (設定)]​ では、必須の HTTP メソッドである ​[Method Type (メソッド種別)]​ を指定します。​[Base Url (ベース URL)]​ では、[Host (ホスト)] と [Base Path (ベースパス)] を指定します。​[Url Extension (URL 拡張)]​ では、リソースを一意に識別します。 単に URL を入力するか、ピン変数を使用して URL を定義できます。

[Parameters (パラメーター)]​ 領域では、必要な情報をエンドポイントに提供します。これにはさまざまなオプションがあり、上記の例と同様にパラメーターを URL に直接入力したり、異なるパラメーター ​[Request Body (リクエストボディ)]​、​[Header Parameter (ヘッダーパラメーター)]​、または ​[Query Parameter (クエリパラメーター)]​ を使用して、「目に見えない方法」でパラメーターを転送したりできます。

[Request Body (リクエストボディ)]​ では、たとえば、サーバーとクライアント間の通信形式を含め、データをサーバーに送信します。 慣習によると、GET、HEAD、DELETE メソッドはボディを必要としません (ネットワークプロトコル RFC 7231 も参照)。

また、[Parameters (パラメーター)] 領域では、画面の左側で、マップされた変数とそれらの ​[Test Values (テスト値)]​ を確認できます。マッピングは、ピン変数を介して実行されます。 [Test Values (テスト値)] では、REST Call が正常に実行されるかどうかを確認できます。これを行うには、すべてのデータを入力して、ウィザードの右下にある ​[Send (送信)]​ をクリックします。

マップされた変数の (実際の) 値は、ワークフローの本番実行まで有効ではありません。

テスト値を含む変数を挿入する手順は、次のとおりです。

  1. 必要な位置をクリックします (​変数を含むリクエストボディ​の領域など)

  2. 右側の関連変数 ({A}、{B}、{C}、…​) をクリックします。これで変数がこの位置に挿入されます。

上の領域では、含まれている変数と共にボディが表示され、下の領域では、Json オブジェクトの分割された変数と共にボディが表示されます。Json を選択した場合、ボディも強調表示され、概観が向上します。

選択オプション ​[Json]​ または ​[Form URL Encoded (URL エンコードされた形式)]​ では、サーバーとクライアントで受け入れられる要求と回答の種別を選択できます。同時に、エントリが準拠しているかどうかがシステムにより確認されます。URL エンコードされた形式への Json 変換をコンテンツタイプのヘッダーパラメーターで参照することもできます。

[Header Parameter (ヘッダーパラメーター)]​ を使用して、収集するリソースや必要な回答形式を正確に記述します。ユーザー定義ヘッダーは、「X-」プレフィックス付きで追加できます (例: x-Customer – Customer ID)。 通常、ここでは、サーバーに対してユーザーを認証するためのログイン情報を指定します。

[Query Parameter (クエリパラメーター)]​ では、リソースを絞り込み、ログイン情報などの詳細情報を追加できます。

[Result Viewer (結果ビューアー)]​ のテキスト結果では、返されたボディ全体を参照でき、解析結果では、JsonPath または Xpath で指定された結果を参照できます。

他のメニューオプションについては、「プロパティ」を参照してください。