REST Web サービス コマンドを使用
- 最終更新日2020/04/17
REST Web サービス コマンドを使用
データ アクセスと交換を自動化するために新しい Web サービスを作成します。
手順
-
REST Web サービスの URI を指定します。
F2 キーを押して、資格情報変数、ローカル変数、システム変数を挿入します。URI 全体に 1 つのローカル変数またはシステム変数を挿入、または 1 つの URI に複数のローカル変数またはシステム変数を挿入できます。例: $vDomain$/$vAPI$/$vParam$注: URI 全体に挿入できる資格情報変数は 1 つだけです。
-
ドロップダウン メニューから、[Method] を選択します。
[GET]、[POST]、[PUT]、[DELETE] から選択します。
-
[リクエスト] の値を指定します。
URI ヘッダー: キーと値のペアについては、以下に説明します。
- HTTPS: HTTPS 接続が使用されている場合は True になります。
- サーバー URL: Web サービスがテストされているメイン ホストまたはサーバーを示します。
- ポート番号: Web サービスとの接続に使用されるポート番号を表示します。
- URL パス: 特定の Web サービスの相対 URL を表示します。
ヘッダー: キーと値のペアは、選択したメソッドに適用されるものとして表示されます。ヘッダーのキーと値のペアは、次のアクション ボタンを使用してカスタマイズできます。- リクエストに追加のフィールドまたはパラメーターがある場合は、Web サービス リクエストにキーと値のペアを追加します。
- [削除] をクリックすることで、キーと値のペアを削除します。
-
[リクエストを送信] ボタンをクリックします。これにより、[レスポンス] が自動的に入力され、処理を簡単にするため変数に保存できるようになります。
URI フィールドで変数を使用する場合:
- [リクエストを送信] をクリックすると、変数のリストを含むメッセージが、それぞれのデフォルト値とともに URI フィールドに挿入されます。
- デフォルト値が設定されていない場合、ユーザーはデフォルト値を変更するか、値を割り当てることができます。[出力を取得] をクリックして、リクエストを送信します。
注: F2 キーを押して資格情報変数を挿入することで、セキュリティを強化できます。 -
[パラメーター] の値を指定します。
- URL: 現在の Web サービス リクエストの URL パラメーターを、キーと値のペアとともに表示します。
- リクエストに追加のフィールドまたはパラメーターがある場合は、記録されたリクエストに URL または POST パラメーターを追加します。
- 行を選択して [削除] をクリックすることで、URL または POST パラメーターを削除します。
- POST パラメーター: 現在のリクエストの POST パラメーターを表示します。Method が POST または PUT である場合に使用できます。
- 認証: REST Web サービスは、HTTP Basic、Windows AD、およびデフォルト ネットワーク資格情報の認証タイプをサポートしています。認証タイプに基づいて、ドメイン、ユーザー名、パスワードなどの認証パラメーターを追加します。
- ログイン中の Active Directory (AD) ユーザーの資格情報を認証に使用するには、すべてのフィールドを空白のままにします。ログイン中のユーザーの AD ドメインが認証用とみなされます。
- 特定の Active Directory ユーザーの資格情報を認証に使用するには、ドメイン、ユーザー名、パスワードを入力します。
- HTTP Basic 認証を使用するには、[ドメイン] フィールドを空白のままにして、ユーザー名とパスワードを入力します。
ヒント: 認証パラメーターを入力するときは、サービスがその認証タイプをサポートすることを確認します。[リクエストを送信] をクリックします。レスポンスが自動的に入力されます。レスポンスは、さらに処理で使用できるよう変数に保管する必要があります。
- URL: 現在の Web サービス リクエストの URL パラメーターを、キーと値のペアとともに表示します。
-
Web サービスのレスポンスは、XML と JSON の両方の形式をサポートします。
- ヘッダー: リクエストに対するレスポンス ヘッダーの詳細なキーと値を表示します。
- 本文: 選択したリクエストに対するレスポンス本文を表示します。このレスポンス本文は、GET メソッドのテスト用の適切な変数に保存しておく必要があります。
- レスポンスの保存先: このオプションは、レスポンス本文全体を保存します。ドロップダウンから変数を選択し、コマンドを保存します。選択した変数は、実行時にレスポンス本文を保管します。
ヘッダーの保存先 (任意): このオプションは、レスポンス ヘッダー全体を保存します。ドロップダウンから変数を選択し、コマンドを保存します。選択した変数は、実行時にレスポンス ヘッダーを保管します。