Automation Anywhere ドキュメントを読んで確認する

Automation Anywhere Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

REST Web Service package

  • 更新済み: 12/01/2020
    • Automation 360 v.x
    • 構築
    • RPA Workspace

REST Web Service package

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

REST Web Service actionsの操作

REST リクエストを送信してレスポンスを受信するには、次の情報を指定します。すべてのメソッドで必ずしもすべてのパラメーターが必要なわけではありません。
  • [URI]: API リソースの一意のアドレス。
  • [認証モード]: 3 つの認証モードがサポートされています。
    • 基本: 基本認証にはテキスト文字列を使用できます。
    • ログイン済み AD ユーザー: 関連する API にアクセスする権限を与えられた Active Directory (AD) ユーザーは、AD を介して認証されます。リクエストに資格情報は必要ありません。
    • Windows NT LAN Manager (NTLM) 認証 (AD ユーザー): 暗号化された資格情報やプレーン テキストとしてユーザー名とパスワードをクライアントが提供できるチャレンジ/レスポンス認証方法。Automation Anywhere Credential Vault に保存されている資格情報を使用することが推奨されます。
  • [ヘッダー]: すべての方法でヘッダーが必要です。ヘッダーは、リクエストに関連付けられたメタデータを表します。
    注: リクエストで API キーを使用するには、[名前] フィールドのヘッダーに「api_key」を入力し、[値] フィールドにキー値を入力します。
  • [失敗レスポンスをキャプチャ]: [成功/OK] のレスポンスを除く失敗レスポンスをキャプチャするには、このチェック ボックスをオンにします。失敗レスポンスの詳細は、レスポンスの本文にキャプチャされます。
  • [コンテンツ タイプ]: コンテンツ タイプを含むヘッダーは、クライアントとサーバー間のコンテンツ ネゴシエーションを定義します。REST Web Service actionsは、次のコンテンツ タイプをサポートします。
    • application/json
    • application/xml
    • text/plain
    • text/html
    • text/xml
  • [出力変数]: レスポンスの出力はディクショナリ変数にキャプチャされます。ディクショナリ変数はキーと値のペアです。レスポンス ヘッダー名をキーとして使用するとヘッダー値が返されます。「本文」をキーとして使用すると、レスポンス本文が返されます。
    注: REST API のレスポンスステータスを表示するために、ディクショナリ変数においてレスポンス キーとその値を使用できます。
    API リソースのヘッダー名のリストを取得するには、次の手順を実行します。
    1. REST Web Service actionの後に Loop actionを挿入します。
    2. [ディクショナリ内の各キー] 反復子を選択します。
    3. [ディクショナリ変数] フィールドで、REST Web Service action出力を保持する変数を選択します。
    4. 各キーの値を $prompt-assignment$ に割り当てます。
    5. [Log To File action] を挿入します。
    6. ヘッダー名のリストを保持するテキスト ファイルへのファイル パスを指定します。
    7. [ログにテキストを入力] フィールドに prompt-assignment$ を挿入します。
    8. [既存のファイルを上書き] オプションを選択します。
    9. [保存] をクリックします。

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

値の安全な受け渡し

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

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

[REST Web Service] package内のActions

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

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

  • URI の長さは 2,048 文字に制限されます。
  • すべてのパラメーターが URI で渡されます。
  • [GET] メソッドは URI に含まれるデータを公開するので、[POST] メソッドに比べて安全性が低くなります。
  • [GET] はデータを変更しないので、承認に関係なく、すべてのユーザーにとって安全に機能します。
Patch メソッド URI によって特定されるリソースを修正します。
POST メソッド URI に新しいリソースを作成します。
  • パラメーターがリクエスト本文で渡されます。
  • リクエスト本文の長さに制限はありません。
PUT メソッド URI または本文で渡されたパラメーターに基づいてリソースが更新または置き換えられます。

プロキシ サポート

デバイスがプロキシで構成されている場合、このpackageからのすべてのアウトバウンド リクエストはプロキシ サーバー経由でルーティングされます。「プロキシを介した Bot agentとデバイスの接続」を参照してください。

フィードバックを送る