リクエスト パラメーター
- 最終更新日2024/10/31
リクエスト パラメーター セクションを使用して、リクエストにパスやクエリなどのさまざまなパラメーターを追加します。 次のパラメーターが、エンドポイント URL で使用されているパラメーターと一致していることを確認してください。
アクション
以下のリクエスト パラメーターのアクションが有効になっています。
- 追加
- クリックしてパラメーターを追加します。
- 編集
- 編集するパラメーターの 3 点アイコンにカーソルを合わせて、編集アイコンをクリックします。
- 削除
- 選択したパラメーターを削除します。
パラメーター テーブル
次に示すパラメーターの詳細をテーブルに表示します。
リクエスト パラメーターの追加
- [リクエスト パラメーター] タブをクリックします。
- [パラメーターを追加] をクリックするか、テーブル上部のプラス (+) アイコンをクリックしてパラメーターを追加します。
- [パラメーターを追加] ウィンドウで、次のパラメーター タイプのいずれかを選択します。
- クエリ: これらのパラメーターは ? 文字の後に URL パスに追加されます。 たとえば、/accounts?user_account=company です。
- パス: これらのパラメーターは URL パスに直接追加されます。 たとえば、/accounts/{user_account} です。
- [キー] フィールドに、適切なキー名を入力します。 キー名は Bot エディターや API タスク エディターでパッケージ ユーザーに表示されません。 この名前はヘッダーの一部として送信されます。
- 次のいずれかのオプションを選択します。
ハード コーディング パラメーターにハード コーディングされる値を入力します。 パッケージ ユーザーは、Bot エディターや API タスク エディターでこの値を表示できません。 この値はヘッダーの一部として送信されます。 ユーザー指定 - 入力値型を保護するかどうかを選択します。 [保護する] を選択すると、資格情報、変数、または安全でない文字列を使用してパラメーターを入力できます。
- このフィールドが必須かどうかを選択します。
- 値を入力します。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでこの値を表示して、更新することができます。
- ラベルを入力します。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでパラメーターのこのラベルを表示できます。
- (任意) 説明を入力します。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでパラメーターのこの説明を表示できます。 エディターでは、ヘルプテキストとして表示されます。