フォームデータリクエストタイプを使用して、リクエスト本文にさまざまなパラメーターを追加します。

アクション

次のパラメーター アクションを使用できます。

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

パラメーター テーブル

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

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

列 説明
キー パラメータキーが表示されます。 パッケージ ユーザーは、Bot エディターや API タスク エディターでキーを表示できません。 キーはヘッダーの一部として送信されます。
キー タイプ フォーム データの種類を表示します。 これにより、データがどのように解釈および処理されるかが決まります。
  • テキスト: キータイプが単純なテキスト入力の場合。 コンテンツはプレーン テキスト (text/plain) として扱われます。 このキータイプは、名前、住所、説明などのデータに適しています。
  • [ファイル]: キーの種類がバイナリ ファイルのアップロードである場合。 コンテンツは、アップロードされたファイルの生データです。 このキータイプは、ドキュメント、画像、その他のバイナリ データをアップロードするために使用されます。
    注: ファイル タイプ フィールドは常にユーザー定義です。ユーザーは、Bot エディターを通じてファイルをアップロードできます。
値 パラメーター値を表示します。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでこの値を表示して、更新することができます。
値はユーザーが指定します 値のステータスを表示します。
  • はい: 値がユーザーにより提供されている場合。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでこのパラメーターを設定するとき、適切な値を指定する必要があります。
  • いいえ: 値がハード コードされている場合。 パッケージ ユーザーは、Bot エディターや API タスク エディターでこの値を表示できません。 この値はヘッダーの一部として送信されます。
ステータス パラメーターのステータスが表示されます。
  • 有効: パラメーターが有効になっている場合。
  • 無効: パラメータが無効になっている場合。
ラベル ユーザー提供 値のラベルを表示します。 パッケージ ユーザーは、Bot エディターや API タスク エディターでパラメータ ラベルを表示できます。
内容 パラメーターの説明を表示します。 パッケージ ユーザーは、Bot エディターまたは API タスク エディターでパラメーターの説明を表示できます。

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

フォームデータリクエストボディにパラメータを追加するための手順を実行します:

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

    新しいパラメータが [パラメータ] テーブルに表示されます。

手順を繰り返して、リクエスト本文にさらにパラメーターを追加します。