Home > リファレンスガイド > 設定 > リソース > RESTクライアント リソース > RESTクライアントパスの設定

REST クライアントパスの設定

パスはRESTful URLの一部です。完全なRESTful API呼び出しURLを形成するために、他のパラメータと一緒にパスがサーバURLに追加されます。

パスボタンをクリックすると、2つのペインを持つウィンドウが開きます。

左側のペインでは、ユーザはパス名を追加および削除することができます。ユーザは、パスパラメータの名前を中括弧({})で囲むことで、ダイナミックなパスパラメータを定義することができます。たとえば、Product/{id}/customersです。ユーザはデータマッパーで動的パスパラメータの値を設定することができます。

  • 次の文字は使用できません、[スペース]  [space] < > | \ ^~ # %。

  • パスパラメータは{}で囲む必要があります。

  • パーセント(%)の文字はサーバURLに使用することができます。

右側のペインでは、ユーザはクエリパラメータやヘッダパラメータ、フォームパラメータを設定することができます。ここで、ユーザは上下の矢印キーを使用してパラメーターを選択し、値を編集することができます。

OKボタンをクリックすると設定は完了し、キャンセルボタンをクリックすると設定は中止されます。

1.クエリパラメータ:

[クエリパラメータ]タブでは、ユーザは次のパラメータを表示および設定することができます。

パラメータ

説明

名前

クエリパラメータ名を入力します。

デフォルト値

デフォルト値を入力します。

 

追加ボタンをクリックすると、新しい[クエリパラメータ]行が追加されます。

削除ボタンをクリックすると、強調表示されている[クエリパラメータ]行が削除されます。

2.ヘッダパラメータ:

[ヘッダパラメータ]タブでは、ユーザは次のパラメータを表示および設定することができます。

パラメータ

説明

名前

クエリパラメータ名を入力します。

デフォルト値

デフォルト値を入力します。

 

追加ボタンをクリックすると、新しい[ヘッダパラメータ]行が追加されます。

削除ボタンをクリックすると、強調表示されている[ヘッダパラメータ]行が削除されます。

3.フォームパラメータ - リクエスト:

[フォームパラメータ - リクエスト]タブでは、ユーザは次のパラメータを表示および設定することができます。

パラメータ

説明

名前

フォームパラメータ - リクエスト名を入力します。

パートタイプ

これは複数選択のグリッドフィールドです。をクリックするとパートのタイプが開きます。

サポートされているパートのタイプは次のとおりです。

  • Attachment

  • Text

パーツタイプで[Attachment]が選択されている場合は、添付ファイルのフォルダへのパスをデータマッパーで指定する必要があります。ユーザは、RESTClientステップを設定しながら、データマッパーで添付ファイルの値をマップすることができます。

データマッパーでフィールドをマッピングするときは、フィールドのタイプが文字型なので、実際の添付ファイルバイナリ(Blob)の内容ではなく、添付ファイルの場所のファイルパスを指定する必要があります。

Content-Type

れは複数選択のグリッドフィールドです。をクリックするとコンテンツタイプが開きます。ユーザは他のコンテンツタイプを追加または削除することもできます。

サポートされているコンテンツタイプは次のとおりです。

  • Application/pdf

  • Application/json

  • Application/xml

  • Image/jpeg

  • Image/png

  • Multipart/form-data

  • Text/plain

  • Text/html

  • Text/xml

エンコーディング

これは複数選択グリッドフィールドです。をクリックするとエンコードが開きます。ユーザは他のエンコーディングを追加または削除することもできます。

サポートされているエンコーディングは次のとおりです。

  • Binary

  • UTF-8

 

追加ボタンをクリックすると、新しい[フォームパラメータ - リクエスト]行が追加されます。

削除ボタンをクリックすると、強調表示されている[フォームパラメータ - リクエスト]行が削除されます。

4.フォームパラメータ - レスポンス:

[フォームパラメータ - レスポンス]タブでは、ユーザは次のパラメータを表示および設定することができます。

パラメータ

説明

名前

フォームパラメータ - レスポンス名を入力します。

パートタイプ

これは複数選択のグリッドフィールドです。クリックするとパートのタイプが開きます。

サポートされているパートのタイプは次のとおりです。

  • Attachment

  • Text

パーツタイプで[Attachment]が選択されている場合は、添付ファイルのフォルダへのパスをデータマッパーで指定する必要があります。ユーザは、RESTClientステップを設定しながら、データマッパーで添付ファイルの値をマップすることができます。

データマッパーでフィールドをマッピングするときは、フィールドのタイプが文字型なので、実際の添付ファイルバイナリ(Blob)の内容ではなく、添付ファイルの場所のファイルパスを指定する必要があります。

Content-Type

れは複数選択のグリッドフィールドです。をクリックするとコンテンツタイプが開きます。ユーザは他のコンテンツタイプを追加または削除することもできます。

サポートされているコンテンツタイプは次のとおりです。

  • Application/pdf

  • Application/json

  • Application/xml

  • Image/jpeg

  • Image/png

  • Multipart/form-data

  • Text/plain

  • Text/html

  • Text/xml

エンコーディング

これは複数選択グリッドフィールドです。をクリックするとエンコードが開きます。ユーザは他のエンコーディングを追加または削除することもできます。

サポートされているエンコーディングは次のとおりです。

  • Binary

  • UTF-8

ユーザは、REST クライアントのステップを追加した後に、データマッパーの[宛先]ペインにあるフォームパラメーターのデフォルト値を上書きすることができます。

追加ボタンをクリックすると、新しい[フォームパラメータ - レスポンス]行が追加されます。

削除ボタンをクリックすると、強調表示されている[フォームパラメータ - レスポンス]行が削除されます。

  • ユーザが既存のステップを選択してパラメータウィンドウを開くまで、リソースのクエリおよびヘッダのパラメーターを変更しても、既存のステップでは自動的に更新されません。

  • ステップの作成後に既存のクエリおよびヘッダパラメータ値が変更された場合、その変更は既存のステップには反映されません。

  • フォームパラメータがリソースレベルで変更されている場合は、既存の手順でスキーマを更新する必要があります。

Since version:

4.9