リクエスト パラメーター

リクエスト パラメーター セクションを使用して、リクエストにパスやクエリなどのさまざまなパラメーターを追加します。 次のパラメーターが、エンドポイント URL で使用されているパラメーターと一致していることを確認してください。

アクション

以下のリクエスト パラメーターのアクションが有効になっています。

追加
クリックしてパラメーターを追加します。
編集
編集するパラメーターの 3 点アイコンにカーソルを合わせて、編集アイコンをクリックします。
削除
選択したパラメーターを削除します。

パラメーター テーブル

次に示すパラメーターの詳細をテーブルに表示します。

テーブル項目 説明
タイプ パラメーターがクエリ パラメーターか、またはタイプ パラメーターかを示します。 パラメーター タイプは、Bot エディターまたは API タスク エディターでパッケージ ユーザーには表示されません。
値はユーザーが指定します 値がユーザーにより提供されているかどうかが表示されます。
  • 値がユーザーにより提供されている場合は「はい」が表示されます。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでこのパラメーターを設定するとき、適切な値を指定する必要があります。
  • 値がハード コードされている場合は「いいえ」が表示されます。 パッケージ ユーザーは、Bot エディターや API タスク エディターでこの値を表示できません。 この値はヘッダーの一部として送信されます。
キー キー名が表示されます。 キー名は Bot エディターや API タスク エディターでパッケージ ユーザーに表示されません。 この名前はヘッダーの一部として送信されます。
値 パラメーター値を表示します。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでこの値を表示して、更新することができます。
ラベル パラメーター ラベルを表示します。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでパラメーターのこのラベルを表示できます。
説明 パラメーターの説明を表示します。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでパラメーターのこの説明を表示できます。

リクエスト パラメーターの追加

  1. [リクエスト パラメーター] タブをクリックします。
  2. [パラメーターを追加] をクリックするか、テーブル上部のプラス (+) アイコンをクリックしてパラメーターを追加します。
  3. [パラメーターを追加] ウィンドウで、次のパラメーター タイプのいずれかを選択します。
    • クエリ: これらのパラメーターは ? 文字の後に URL パスに追加されます。 たとえば、/accounts?user_account=company です。
    • パス: これらのパラメーターは URL パスに直接追加されます。 たとえば、/accounts/{user_account} です。
  4. [キー] フィールドに、適切なキー名を入力します。 キー名は Bot エディターや API タスク エディターでパッケージ ユーザーに表示されません。 この名前はヘッダーの一部として送信されます。
  5. 次のいずれかのオプションを選択します。
    ハード コーディング パラメーターにハード コーディングされる値を入力します。 パッケージ ユーザーは、Bot エディターや API タスク エディターでこの値を表示できません。 この値はヘッダーの一部として送信されます。
    ユーザー指定
    1. 入力値型を保護するかどうかを選択します。 [保護する] を選択すると、資格情報、変数、または安全でない文字列を使用してパラメーターを入力できます。
    2. このフィールドが必須かどうかを選択します。
    3. 値を入力します。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでこの値を表示して、更新することができます。
    4. ラベルを入力します。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでパラメーターのこのラベルを表示できます。
    5. (任意) 説明を入力します。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでパラメーターのこの説明を表示できます。 エディターでは、ヘルプテキストとして表示されます。