REST Web サービス パッケージ
REST Web サービス パッケージ の アクション をメソッド (DELETE、GET、PATCH、POST、または PUT) として使用し、API へリクエストを送信して API からレスポンスを受信します。
REST Web サービス アクション の操作
REST リクエストを送信してレスポンスを受信するには、次の情報を指定します。すべてのメソッドで必ずしもすべてのパラメーターが必要なわけではありません。
- URI を入力: API リソースの一意のアドレス。
- 認証モード: 3 つの認証モードがサポートされています。
- 認証なし: サーバーへのアクセスに認証を必要としないエンドポイントにアクセスするには、このオプションを使用します。
- 基本: [基本] は、ユーザーを認証する最も簡単な方法です。このオプションを選択した場合は、ユーザー名とパスワードを入力します。この手法では、入力されたユーザー名およびパスワードを base64 でエンコードした「Authorization」というヘッダーを使用します。
- ログイン済み AD ユーザー: 関連する API にアクセスする権限を与えられた Active Directory (AD) ユーザーは、AD を介して認証されます。リクエストに資格情報は必要ありません。
- Windows NT LAN Manager (NTLM) 認証 (AD ユーザー): 暗号化された資格情報やプレーン テキストとしてユーザー名とパスワードをクライアントが提供できるチャレンジ/レスポンス認証方法。Automation Anywhere 資格情報 Vault に保存されている資格情報を使用することが推奨されます。
- ヘッダー: すべてのメソッドでヘッダーが必要です。ヘッダーは、リクエストに関連付けられたメタデータを表します。
- コンテンツタイプ: コンテンツ タイプを含むヘッダーは、クライアントとサーバー間のコンテンツ ネゴシエーションを定義します。REST Web サービス アクション は、以下のコンテンツ タイプをサポートしています。
application/x-www-form-urlencoded: URL のパラメーターをエンコードします。JSON (application/json): JSON 要求本文を入力します。XML (application/xml): XML 要求本文を入力します。Text (text/plain)XML (text/xml)HTML (text/html)multipart/form-data: ほとんどの場合、ファイルをサーバーにアップロードするためにバイナリ データを送信します。
- 置換を追加: REST 要求本文に変数を入力できます。変数はデータのシンボリック表現であり、必要な場合は、手動で入力しなくても値にアクセスできます。たとえば、次の REST 本文の要求について考えてみましょう。
上記の要求本文では、[置換を追加] をクリックして必要な値を追加することで、二重カッコで囲まれた変数を置換できます。{ "name":"{{name}}", "email":"{{email}}", "status":"Active" } - 詳細オプション:
- 失敗応答をキャプチャ: [成功/OK] のレスポンスを除く失敗レスポンスをキャプチャするには、このチェック ボックスをオンにします。失敗レスポンスの詳細は、レスポンスの本文にキャプチャされます。
- https を使用するときは、安全でない接続を許可します: https を使用するときに安全でない接続を許可する場合は、チェックボックスをオンにします。
- アクションの完了を待機: REST リクエストを送信してレスポンスを受信するまでのタイムアウト値を設定できます。POST、PUT、DELETE、PATCH、GET などの アクション を実行する場合、[アクションの完了を待機] フィールドで待機時間 (ミリ秒単位) を指定できます。デフォルトでは、待機時間は 60,000 ミリ秒です。
- 出力変数: レスポンスの出力はディクショナリ変数にキャプチャされます。ディクショナリ変数はキーと値のペアです。レスポンス ヘッダー名をキーとして使用するとヘッダー値が返されます。「本文」をキーとして使用すると、レスポンス本文が返されます。注: REST API のレスポンス ステータスを表示するために、ディクショナリ変数においてレスポンス キーとその値を使用できます。API リソースのヘッダー名のリストを取得するには、次の手順を実行します。
- REST Web サ