REST Web Services package

REST Web Services packageのactionsをメソッド (DELETE、GET、PATCH、POST、または PUT) として使用し、API へリクエストを送信して API からレスポンスを受信します。

設定

REST Web Services actions の設定は、以下のとおりです。 適切な設定を構成して REST リクエストを送信し、レスポンスを受信します。 各メソッドには、特定のパラメーターが必要です。

注: macOS プラットフォームで自動化を作成し、(DELETE, GET, PATCH, POST, PUT) のような actions を使用する場合、次の認証モードはサポートされていません:
  • NTLM 認証（AD ユーザー）
  • ログイン済み AD ユーザー
URI
API リソースの URI を入力します。 次のオプションのいずれかを選択し、それに応じて設定を構成します。
  • URI を入力: URI を直接入力するか、文字列変数として保存されたURIを選択してください。
  • 資格情報を URI として選択: このオプションを使用して、Credential Vault に保存されている資格情報としての URI を選択します。 資格 > 選択を使用して、資格を直接選択します。 [変数] オプションを使用して、認証情報変数にマッピングされた認証情報を選択することもできます。 このオプションを使用すると、認証コードや API キーなどの機密情報を含む URI を非表示にすることができます。
プロキシ構成
REST Web Services アクションのプロキシ設定を構成します。 次のオプションのいずれかを選択し、それに応じて設定を構成します。
  • システム: このオプションを選択すると、Bot Agentがシステム プロキシを使用できるようになります。 システム プロキシは、オートメーションが実行される bot ランナー マシンに設定するプロキシです。
  • カスタム: このオプションを選択して、自動化のためのカスタムプロキシ設定を構成します。 以下の設定を構成します。
    • ホスト: プロキシ サーバーのホスト名または IP アドレス。
    • ポート: プロキシサーバーのポート番号。
    • ユーザー名 (任意): プロキシサーバーの認証用ユーザー名。
    • パスワード (任意): プロキシサーバーの認証用パスワード。
    注: 任意の認証プロキシサーバーには、ユーザー名 と パスワード を設定する必要があります。
    [資格情報]、[変数]、[安全でない文字列] のいずれかのオプションを使用してプロキシ設定を構成できます。
    • 資格情報: Credential Vault で利用可能な値を選択するには。
    • 変数: 値にマッピングされた資格情報変数を選択するには。
    • 安全でない文字列: 値を手動で入力するか、事前に定義された文字列変数にマッピングされた値を選択します..
認証モード
REST Web Services アクションの認証設定を構成します。 次のオプションのいずれかを選択し、それに応じて設定を構成します。
  • 認証なし: このオプションを選択すると、サーバーへのアクセスに認証を必要としないエンドポイントにアクセスできます。
  • Control Room ユーザー トークン: このオプションを選択すると、Control Roomにログインしたときに生成されたトークンを使用します。
  • 基本: このオプションを選択して、ユーザー名 と パスワード を入力し、REST Web Services API コールを認証します。 このオプションは、API コールに ユーザー名 および パスワード を base64 でエンコードした文字列を含む Authorization という名前のヘッダーを追加します。
  • ログイン済み AD ユーザー: このオプションを選択して、Active Directory（AD）ベースの認証を選択します。 関連する API にアクセスする権限を与えられた AD ユーザーは、AD を使用して認証されます。 リクエストに資格情報は必要ありません。
  • Windows NT LAN Manager (NTLM) 認証 (AD ユーザー): このオプションを選択して、チャレンジ応答 NTLM 認証を選択します。 以下の設定を構成します。
    • ドメイン: API 呼び出しを認証する必要があるドメインを入力してください。 ドメインまたはホストにマッピングされた文字列変数を選択することもできます。
    • ユーザー名 (任意): API呼び出しの認証に使用するユーザー名。
    • パスワード (任意): API 呼び出しの認証用パスワード。
    [資格情報]、[変数]、[安全でない文字列] のいずれかのオプションを使用してユーザー名とパスワードを構成できます。 から資格情報を選択するために 資格情報Credential Vault オプションを使用するか、資格情報変数を使用することをお勧めします。
  • OAuth2 - Control Room 管理: このオプションを選択して、Control Room 管理された OAuth 接続を認証オプションとして選択します。 詳細については、Configure OAuth connections in Control Roomを参照してください。

    次の動画では、REST Web Servicesで OAuth接続を使用する方法を示します。

ヘッダー
APIリクエストに追加のメタデータを含めるためにカスタムヘッダーを追加します。 すべてのメソッドがヘッダーを必要とするわけではありません。 Authorization、Accept-Charset、Content-Type、Cache-Control、User-エージェント などのヘッダーを追加できます。

ヘッダーを追加をクリックし、カスタムヘッダーモーダルの指示に従って、必要なヘッダーを追加します。 Credential Vault に保存されている資格情報を選択するか、資格情報変数を使用するか、またはヘッダーを直接不安全な文字列として入力できます。

コンテンツ タイプ
コンテンツタイプ ヘッダーは、リクエストボディ内のコンテンツのメディアタイプを定義します。 REST Web Services actionsは、以下のコンテンツ タイプをサポートしています。
  • application/x-www-form-urlencoded: パラメータを URL クエリ文字列形式でエンコードします。
  • JSON（application/json）: JSON 形式の要求本文を入力します。
  • XML (application/xml): XML 形式の要求本文を入力します。
  • テキスト (text/plain) プレーンテキスト形式でテキストタイプのリクエストボディを入力してください。
  • XML (text/xml): XML形式でテキストタイプのリクエストボディを入力してください。
  • HTML (text/html): HTML形式でテキストタイプのリクエストボディを入力してください。
  • マルチパート/フォームデータ リクエスト本文にテキストとファイルの両方を含めることができます。 このコンテンツタイプは、API がサポートするすべてのファイル形式をサポートしています。 このコンテンツ タイプは、1 回のリクエストで複数の部分を送信する場合に使用できます。通常は、テキスト データ (フォーム フィールドなど) やファイル アップロードなどが含まれます。 このコンテンツ タイプもファイル ストリーミングをサポートしています。
    ファイルストリームは、ファイル型の変数に割り当てた後で読み取ることができます。 たとえば、OneDrive の場所にある変数に割り当てられたファイル ストリームを読み取ることができます。 詳細については、ファイルの代入actionを参照してください。
    REST Web サービス FileStream
  • バイナリ: バイナリ を使用して、画像、ビデオ、音声ファイルなどの生ファイルを送信します。 次のいずれかのオプションを使用して、ファイルをアップロードできます。
    • 変数: デスクトップまたは Control Room 内からファイルをアップロードするためにファイル変数を割り当てます。 このオプションを使用して、ストレージの場所からファイルをストリーミングすることもできます。
    • Control Room ファイル: Control Room ストレージにあるファイルをアップロードします。
    • デスクトップ ファイル: デスクトップから直接ファイルをアップロードします。
  • カスタム
    カスタム: 標準コンテンツ タイプに該当しないカスタム コンテンツを追加します。 たとえば、v.11.x から Automation 360 に移行する場合、application/vnd.whispir.message-v1+json は標準コンテンツ タイプのいずれにも該当しません。

application/x-www-form-urlencoded と multipart/form-data の場合は、パラメータを追加 をクリックし、パラメータ モデルの指示に従って必要なヘッダー パラメータを追加してください。

他のコンテンツタイプの場合、パラメータを入力オプションまたは資格情報をパラメータとして選択オプションを使用してパラメータを追加できます。 パラメータとして資格情報を選択 オプションを使用すると、リクエストヘッダーとして機密データを追加できます。

置換を追加
置換を追加 オプションを使用すると、REST 要求本文に変数を入力できます。 このオプションは、JSON (application/json)、XML (application/xml)、テキスト (text/plain)、XML (text/xml)、HTML (text/html)、および カスタム コンテンツタイプヘッダーに対して利用可能です。
変数はデータのシンボリック表現であり、必要な場合は、手動で入力しなくても値にアクセスできます。 たとえば、次の REST 本文の要求について考えてみましょう。
{
   "name":"{{name}}",
   "email":"{{email}}",
   "status":"Active"
}
上記の要求本文では、置換を追加 をクリックして必要な値を追加することで、二重カッコで囲まれた変数を置換できます。
詳細オプション
失敗応答をキャプチャ: [成功/OK] のレスポンスを除く失敗レスポンスをキャプチャするには、このチェック ボックスをオンにします。 システムは、レスポンス ボディに失敗応答の詳細をキャプチャします。 このオプションは、Delete、Get、Patch、Post、Put メソッドのアクションで利用できます。
https を使用するときは、安全でない接続を許可します: https プロトコルを使用するときに安全でない接続を許可する場合は、チェックボックスをオンにします。 このオプションは、すべてのアクションで利用できます。
Cookie を受け入れる: サーバーのレスポンスからセッション Cookie を自動的にキャプチャするには、このチェック ボックスをオンにします。 このチェックボックスを選択すると、次の機能が背後で有効になります。
  • キャプチャ: システムは、サーバーがレスポンスに含めるセッションクッキーをキャプチャします。
  • 安全な保管: システムはキャプチャされた Cookie をプロセス メモリ内で暗号化し、永久に保存されることがなく、オートメーション セッション外ではアクセスできないようにします。
  • 再利用: システムは自動的に Cookie を後続の REST 呼び出しに含めるため、手動での Cookie 処理が不要になり、オートメーションの信頼性が向上します。
  • 複数の Cookie の処理: このシステムは、サーバーから返される複数の Cookie を自動化で処理し、必要な認証情報がすべて含まれていることを保証します。
  • 破壊: システムは、オートメーション セッションの終了時または Bot の実行終了時にキャプチャされた Cookie を自動的に破棄し、データのセキュリティとプライバシーを確保します。

このオプションは、Delete、Get、Patch、Post、Put メソッドのアクションで利用できます。

注: キャプチャされた Cookie は、発行元のドメインに固有のものであり、異なるドメインに対して行われるその後の REST 呼び出しに自動的に使用されることはありません。 これは、domainA.com からキャプチャされた Cookie は、domainB.com へのリクエストには利用されないことを意味します。
ファイルをダウンロード: このチェックボックスを選択して、URIにあるバイナリファイルを特定の場所にダウンロードします。 希望するファイルパスを、名前と拡張子を含めて入力してください。 例: <C:/Users/Downloads/image01.jpg>

このオプションは、Get メソッドのアクションでのみ利用できます。 システムは、以下のいずれかのシナリオが発生したときにエラーメッセージを表示します:

  • 無効な URI： 提供された URI が正しくない場合。
  • ファイルが見つかりません: 指定された場所にファイルが存在しないため、API の応答が空の場合です。
  • 権限が不足しています。 ダウンロード先に対する書き込み権限がない場合です。
  • ファイル拡張子の不一致: ファイル拡張子が期待されるタイプと一致しない場合。

新しいバージョンで既存のファイルを上書きするには、ファイルが既に存在する場合は上書き チェックボックスを有効にします。

アクションの完了を待機
REST リクエストを送信してレスポンスを受信するまでのタイムアウト値を設定できます。 actions を実行する際は、POST、PUT、DELETE、PATCH、GET など、アクションが完了するまで待機 フィールドに待機時間（ミリ秒単位）を指定してください。 デフォルトでは、待機時間は 60,000 ミリ秒です
SSL/TLS の設定
このオプションを使用して、REST API 呼び出し中に追加の認証を提供するために、パスワードの有無にかかわらず証明書ファイルをアップロードします。

SSL/TLS 構成 は、API URI とクライアント間の通信を暗号化し、認証し、保護するために相互 TLS (mTLS) プロトコルを使用します。mTLS は、両方のエンティティが証明書を交換してお互いを認証することを要求します。 両方のエンティティが交換された証明書を正常に認証した場合にのみ、データ送信が行われます。

REST Web Servicesは Windows マシン用の.p12タイプの証明書と、非 Windows マシン用の.pfxフォーマットをサポートしています。

  • キーストア ファイル パス (任意): [変数]、[Control Room ファイル]、または [デスクトップ ファイル] オプションを使用して証明書ファイルをアップロードします。
  • キーストア パスワード (任意): 証明書がパスワードで保護されている場合、資格情報、変数、または不確実な文字列オプションを使用して証明書パスワードを認証できます。 資格情報 ロッカーにパスワードを安全に保存する方法についての詳細は、Credential Vault の資格情報と lockers を参照してください。
出力を変数に代入します
レスポンスの出力はディクショナリ変数にキャプチャされます。 ディクショナリ変数はキーと値のペアです。 レスポンス ヘッダー名をキーとして使用するとヘッダー値が返されます。「本文」をキーとして使用すると、レスポンス本文が返されます。

このオプションは、Delete、Get、Patch、Post、Put メソッドのアクションで利用できます。

注: ディクショナリ変数でレスポンス キーとその値を使用して、REST API のレスポンス ステータスを表示できます。
API リソースのヘッダー名のリストを取得するには、次の手順を実行します。
  1. Loop actionの後にREST Web Services actionを挿入します。
  2. [ディクショナリ内の各キー] 反復子を選択します。
  3. ディクショナリ変数 フィールドで、REST Web Services action出力を保持する変数を選択します。
  4. 各キーの値を $prompt-assignment$ に割り当てます。
  5. [ファイルにテキストを記録] を挿入しますaction。
  6. ヘッダー名のリストを保持するテキスト ファイルへのファイル パスを指定してください。
  7. [ログにテキストを入力] フィールドに $prompt-assignment$ を挿入します。
  8. 既存のファイルを上書き オプションを選択します。
  9. [保存] をクリックします。

    bot を実行すると、API リソースから選択したファイルにヘッダー名が印刷されます。

ファイルを変数に代入する
このオプションは、ファイルストリームの取得アクションでのみ利用できます。 ファイルストリーム取得アクションを使用すると、ファイル変数を URI で利用可能なファイルに割り当てることができます。 その後、このファイル変数をセッション内の任意の後続アクションで使用できます。 ファイル変数の割り当てについて詳しくは、[ファイルストリーム取得アクションの使用]を参照してください。

値の安全な受け渡し

Credential Vault から Web サービスに値を安全に渡すには、サポートされている次のlocker フィールドにaction、資格情報、および属性を指定します。
  • URI
  • カスタム ヘッダー
  • 本文: application/x-www-form-urlencoded コンテンツ タイプの場合は、[パラメーターを追加] をクリックして Credential Vault から値を選択します。

    他のすべてのコンテンツ タイプでは、資格情報をパラメーターとして選択 オプションを選択して 選択 をクリックします。

REST Web Services packageのActions

Action 説明
Delete メソッド URI によって特定されるリソースを削除します。
GET メソッド URI に含まれるパラメーターによって特定された情報を取得します。 GET メソッドには、すべてのパラメーターが URI の一部として渡されるため、コンテンツ タイプ はありません。

GET メソッドの制限と特徴には次が含まれます。

  • URI の長さは 2,048 文字に制限されています。
  • すべてのパラメーターが URI で渡されます。
  • GET メソッドは URI に含まれるデータを公開するので、POST メソッドに比べて安全性が低くなります。
  • GET はデータを変更しないため、承認に関係なくすべてのユーザーにとって安全です。

[GET メソッドの使用]を参照してください。
Patch メソッド URI によって特定されるリソースを修正します。
POST メソッド URI に新しいリソースを作成します。
  • パラメーターがリクエスト本文で渡されます。
  • リクエスト本文の長さに制限はありません。

[POST メソッドの使用]を参照してください。
PUT メソッド URI または本文で渡されたパラメーターに基づいてリソースが更新または置き換えられます。 [PUT メソッドの使用]を参照してください。

Proxy support

If your device is configured with a proxy, all outbound requests from this package are routed through the proxy server. See Bot Agent とプロキシの設定されているデバイスの接続.