Automation 360

REST Web サービスパッケージ

PDF としてダウンロード

コンテンツ

REST Web サービスパッケージ

PDF としてダウンロード

最終更新日2024/12/02

REST Web サービスパッケージ

アクション REST Web サービスのパッケージをメソッド (DELETE、GET、PATCH、POST、または PUT) として使用し、API へリクエストを送信し API からレスポンスを受信します。

REST Web サービスアクションの操作

REST リクエストを送信してレスポンスを受信するには、次の情報を指定します。すべてのメソッドで必ずしもすべてのパラメーターが必要なわけではありません。

URI を入力: API リソースの一意のアドレス。

プロキシ構成: プロキシを設定するには、[プロキシ構成] からシステムまたはカスタムタブを選択します。


オプション	説明
システム	システムプロキシは、Bot が動作している Bot ランナーマシンに設定されているプロキシです。このオプションが選択されている場合、Bot エージェントはシステムプロキシを使用します。
カスタム	このオプションは、アクションのREST Web サービス内でカスタムプロキシを設定することができます。たとえば、REST API をシステムプロキシ以外の別のプロキシでルーティングする必要がある場合、カスタムオプションを選択し、REST アクション内にプロキシの詳細を指定することが可能です。以下の詳細を指定します。ホスト: プロキシのホスト名または IP アドレスポート: プロキシのポート番号ユーザー名 (任意): プロキシ認証に使用するユーザー名パスワード (任意): プロキシ認証に使用するパスワード注: 設定するプロキシが認証プロキシである場合、ユーザー名とパスワードのフィールドに資格情報を入力する必要があります。ホスト、ポート、ユーザー名、およびパスワードの各フィールドの場合、資格情報、変数、または安全でない文字列タブから選択します。資格情報: 資格情報コンテナーで利用可能な値を使用します。変数: ユーザー定義変数に資格情報値を保存する変数を使用します。安全でない文字列: 使用する値を手動で指定します。

認証モード: 3 つの認証モードがサポートされています。
- 認証なし: サーバーへのアクセスに認証を必要としないエンドポイントにアクセスするには、このオプションを使用します。
- Control Room ユーザートークン: REST Web サービスアクションは、Control Roomへのログイン時に生成されたトークンを使用してエンドポイントにアクセスします。
- 基本: [基本] は、ユーザーを認証する最も簡単な方法です。このオプションを選択した場合は、ユーザー名とパスワードを入力します。この手法では、入力されたユーザー名およびパスワードを base64 でエンコードした「Authorization」というヘッダーを使用します。
- ログイン済み AD ユーザー: 関連する API にアクセスする権限を与えられた Active Directory (AD) ユーザーは、AD を介して認証されます。リクエストに資格情報は必要ありません。
- Windows NT LAN Manager (NTLM) 認証 (AD ユーザー): 暗号化された資格情報やプレーンテキストとしてユーザー名とパスワードをクライアントが提供できるチャレンジ/レスポンス認証方法。 Automation Anywhere Credential Vault に保存されている資格情報を使用することが推奨されます。
- OAuth2 - Control Room でマネージ: OAuth と Control Room を統合すると、サードパーティプロバイダーの認証に使用するトークンを一元管理し、安全に保管できます。 Control Room で OAuth 接続を使用するには、Web サービスを構成し、認証の詳細 (クライアント ID、クライアントシークレット、認証 URL など) をメモしておく必要があります。詳細については、Control Room で OAuth 接続を構成するを参照してください
  次の動画では、OAuthで REST Web サービス接続を使用する方法を示します。
  <span>REST Web サービスで OAuth 接続を使用する方法を説明する動画</span>
ヘッダー: すべてのメソッドがヘッダーを必要とするわけではありません。ヘッダーは、リクエストに関連付けられたメタデータを表します。
コンテンツタイプ: コンテンツタイプを含むヘッダーは、クライアントとサーバー間のコンテンツネゴシエーションを定義します。REST Web サービスアクションは、次のコンテンツタイプをサポートします。
- application/x-www-form-urlencoded: URL のパラメーターをエンコードします。
- JSON (application/json): JSON 要求本文を入力します。
- XML (application/xml): XML 要求本文を入力します。
- テキスト (text/plain)
- XML (text/xml)
- HTML (text/html)
- マルチパート/フォームデータ
  - ほとんどの場合、ファイルをサーバーにアップロードするためにバイナリデータを送信します。これは、1 回のリクエストで複数の部分を送信する場合に使用されます。通常は、テキストデータ (フォームフィールドなど) やファイルアップロードなどが含まれます。 FileStream 変数を使用することもできます。詳細については、以下をご覧ください。
  - FileStream: FileStream は、変数に割り当てた後で読み取ることができます。たとえば、OneDrive の場所にある変数に割り当てられた FileStream を読み取ることができます。詳細については、「ファイルの代入アクション」を参照してください。
- バイナリ: Binary を使用して、画像、ビデオ、音声ファイルなどの生ファイルを送信します。バイナリを選択すると、バイナリファイル（変数として、Control Roomファイルまたはデスクトップファイル）をアップロードできるようになります。
- カスタム
  カスタム: 標準コンテンツタイプに該当しないカスタムコンテンツを追加します。たとえば、v.11.x から Automation 360 に移行する場合、application/vnd.whispir.message-v1+json は標準コンテンツタイプのいずれにも該当しません。
置換を追加: REST リクエスト本文に変数を入力できます。変数はデータの象徴的な表現であり、手動で入力することなく、必要な場所で値にアクセスできるようにします。たとえば、次の REST リクエスト本文について考えてみましょう。
```
{
   "name":"{{name}}",
   "email":"{{email}}",
   "status":"Active"
}
```
上記のリクエスト本文では、置換の追加をクリックして必要な値を追加することで、二重中括弧で囲まれた変数を置き換えることができます。
詳細オプション:
- [キャプチャ失敗レスポンス: 失敗応答をキャプチャするには、チェックボックスをオンにします。（成功/OK応答を除く応答）。その失敗レスポンスの詳細は、レスポンスの本文にキャプチャされます。
- httpsを使用する際安全でない接続を許可する: httpsを使用する際安全でない接続を許可するチェックボックスを選択します。
- 承諾クッキー: サーバー応答からセッションクッキーを自動的にキャプチャするには、チェックボックスをオンにします。
  - キャプチャ: この機能を有効にすると、サーバー応答に含まれるセッションクッキーがキャプチャされます。
  - 安全な保管: キャプチャされた Cookie はプロセスメモリ内で暗号化されるため、永続的に保存されることはなく、自動化セッション外からはアクセスできません。
  - 再利用: Cookiesは後続の REST 呼び出しに自動的に含まれるため、手動でのクッキー処理が不要になり、自動化の信頼性が向上します。
  - 複数の Cookie の処理: この機能は、サーバーから返される複数の Cookie をシームレスに処理し、必要な認証資格情報がすべて含まれていることを保証します。
  - 破壊: キャプチャされた Cookie は、自動化セッションが終了するかBotの実行が終了すると自動的に破棄され、データのセキュリティとプライバシーが確保されます。
  注: キャプチャされた Cookie は、その Cookie の発信元のドメインに固有のものであり、異なるドメインに対して行われる後続の REST 呼び出しには自動的に使用されません。つまり、 domainA.com からキャプチャされた Cookie は domainB.com へのリクエストには使用されません。
- ファイルをダウンロード: (Get メソッドでのみ使用可能) ファイルを特定の場所にダウンロードするには、このチェックボックスをオンにします。 URIはファイルを返す/ダウンロードする必要があります。目的のフォルダーパスと拡張子付きのファイル名を入力します。正しいファイル拡張子を使用していることを確認してください。例えば、 C:/Users/Downloads/image01.jpg
  ヒント: ファイルの保存先のフォルダーに同じ名前のファイルが既に存在する場合は上書きするには、ファイルが既に存在する場合は上書きするオプションをオンにします。
  
  エラー処理:
  
  無効な URI:
  
  提供された URI が正しくない場合は、エラーメッセージが表示されます。
  
  ファイルが見つかりません:
  
  指定された場所にファイルが存在しないために API 応答が空の場合は、エラーメッセージが表示されます。
  
  権限が不足しています:
  
  ダウンロード先に対する書き込み権限がない場合、エラーメッセージが表示されます。
  
  ファイル拡張子の不一致:
  
  ファイル拡張子が期待されるタイプと一致しない場合、エラーメッセージが表示されます。
アクションの完了を待機: REST リクエストを送信してレスポンスを受信するまでのタイムアウト値を設定できます。 . POST、PUT、DELETE、PATCH、GET などのアクションを実行する場合、アクションが完了するまでの待機時間フィールドで、待機時間 (ミリ秒単位) を指定できます。デフォルトでは、待機時間は 60,000 ミリ秒です。
出力変数: レスポンスの出力はディクショナリ変数です。ディクショナリ変数はキーと値のペアです。ヘッダー値を返すには、応答ヘッダー名をキーとして使用し、応答本文を返すには、「Body」をキーとして使用します。
注: 応答キーとその値は辞書変数で使用でき、 REST API の応答ステータスを表示できます。
API リソースのヘッダー名のリストを取得するには、次の手順を実行します。
1. ループを挿入アクションの後に REST Web サービスアクション.
2. ディクショナリ内の各キーイテレータを選択します。
3. ディクショナリ変数フィールドで REST Web サービスを保持する変数アクション出力を選択します。
4. 各キーの値を $prompt-assignment$ に割り当てます。
5. ファイルに記録を挿入アクション.
6. ヘッダー名のリストを保持するテキストファイルへのファイルパスを指定します。
7. $prompt-assignment$ をログにテキストを入力フィールドに挿入します。
8. 既存のファイルを上書きオプションを選択します。
9. 保存をクリックします。
  Bot を実行すると、API リソースから選択したファイルにヘッダー名が印刷されます。

値の安全な受け渡し

サポートされている次の Credential Vault、認証情報、属性を指定することにより、ロッカーから Web サービスに値を安全に渡すことができます（アクションフィールドに）

URI
カスタムヘッダー
本文: application/x-www-form-urlencoded コンテンツタイプの場合、クリックパラメータを追加して Credential Vault から値を選択します。
その他のコンテンツタイプについては、パラメーターとして資格情報を選択オプションを選択して選択をクリックします。

アクションのREST Web サービスパッケージ


アクション	説明
Delete メソッド	URIによって特定されるリソースを削除します。
GET メソッド	URIに含まれるパラメーターによって特定された情報を取得します。 GET メソッドにはコンテンツタイプはありません。すべてのパラメータが URI の一部として渡されるためです。 GET メソッドの制限と特徴以下のものが含まれています。 URI の長さは 2,048 文字に制限されます。すべてのパラメーターが URI で渡されます。 GET メソッドはデータを公開します URIは、POST メソッドよりも安全性が低くなります。 GET はデータを変更しないため、すべてのユーザーに対して、認証に関係なく安全です。「GET メソッドの使用」を参照してください。
Patch メソッド	URIによって特定されるリソースを修正します。します。
POST メソッド	URI に新しいリソースを作成します。パラメーターがリクエスト本文で渡されます。リクエスト本文の長さに制限はありません。「POST メソッドの使用」を参照してください。
PUT メソッド	URIまたはボディに渡されたパラメーターに基づいてリソースが更新または置き換えられます。「PUT メソッドの使用」を参照してください。