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

アクション

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

追加
リクエストにパラメータを追加する。
[追加] アイコンをクリックしてパラメータを追加します。 パラメータ テーブルのタイトルに表示されるパラメータの数は自動的に更新されます。
編集
リクエストで利用可能な既存のパラメータを編集するため。
パラメータテーブルで、適切なパラメータの垂直の省略記号アイコンにカーソルを合わせ、編集 アイコンをクリックして パラメータタイプ、キー、値、または 値タイプ を編集します。
有効/無効
リクエストで利用可能なパラメータを有効または無効にします。 次のシナリオでは、パラメータを無効にすることができます。
  • APIリクエストがデフォルト値を使用しているとき。
  • 制御されたコネクタパッケージの展開で新しい機能を導入する際。
  • コネクタパッケージの新しい機能をテストし、反復する際。
  • エラーを含むパラメータがあるコネクタパッケージのトラブルシューティングを行うとき。
パラメータ テーブルで、有効または無効にしたいパラメータの垂直の省略記号アイコンにカーソルを合わせ、有効/無効 トグルをクリックします。 パラメータのステータスが [パラメータ] テーブルでそれに応じて更新されます。 無効なパラメータは公開されたコネクタパッケージに含まれていません。
コピー
リクエストで利用可能な既存のパラメータを複製するため。
パラメータ テーブルで、適切なパラメータの縦の省略記号アイコンにカーソルを合わせ、コピー アイコンをクリックして選択したパラメータを複製します。 コピー モーダルに新しいキーを入力してください。 元のパラメータの他のすべての属性は新しいパラメータにコピーされます。 コピーされると、新しいパラメータはデフォルトで有効になります。 必要に応じて、有効/無効 トグルを使用して、パラメータを手動で無効にします。 パラメータ テーブルタイトルのパラメータ数は、コピー オプションを使用して新しいパラメータが作成されると自動的に更新されます。
複製されたパラメータの パラメータタイプ、値、または 値タイプ を コピー モーダルで変更できます。
削除
リクエストで利用可能なパラメータを削除する。
次のいずれかを実行してパラメーターを削除します。
  • テーブルヘッダーの すべて選択 チェックボックスをクリックし、その後テーブルの上にある 削除 アイコンをクリックして複数のパラメータを削除します。
  • 各パラメータの垂直の省略記号メニューにカーソルを合わせてから、削除 アイコンをクリックしてパラメータを個別に削除します。

パラメーター テーブル

パラメータ テーブルのタイトルは、アクション内のリクエストパラメータの総数を表示します。 この数値には、有効および無効のパラメータの両方が含まれています。

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

列 説明
タイプ パラメーターの種類を表示します。 パラメータは クエリ パラメータまたは パス パラメータである可能性があります。 パッケージ ユーザーは、Bot エディターや API タスク エディタでパラメータの種類を表示できません。
キー パラメータキーが表示されます。 パッケージ ユーザーは、Bot エディターや API タスク エディターでキーを表示できません。 キーはヘッダーの一部として送信されます。
値 パラメーター値を表示します。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでこの値を表示して、更新することができます。
値はユーザーが指定します 値のステータスを表示します。
  • はい: 値がユーザーにより提供されている場合。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでパラメーターを設定する際に、適切な値を指定しなければなりません。
  • いいえ: 値がハード コードされている場合。 パッケージ ユーザーは、Bot エディターや API タスク エディターでこの値を表示できません。 この値はヘッダーの一部として送信されます。
ステータス パラメーターのステータスが表示されます。
  • 有効: パラメーターが有効になっている場合。
  • 無効: パラメータが無効になっている場合。
ラベル ユーザー提供 値のパラメータラベルを表示します。 パッケージ ユーザーは、Bot エディターや API タスク エディターでパラメータ ラベルを表示できます。
説明 パラメーターの説明を表示します。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでパラメーターの説明を表示できます。

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

リクエストパラメーターを追加するための手順を実行します:

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

    新しいパラメータは パラメータ テーブルに表示され、テーブルタイトルのパラメータ数は自動的に更新されます。

手順を繰り返して、さらに多くのパラメータを追加します。