アクションを手動で追加する場合、パスとクエリパラメーター、ヘッダー、リクエスト、レスポンスを追加してアクションの詳細を設定する必要があります。

API 定義をインポートする場合、アクションの詳細を確認して編集し、アクションに要件に基づいた適切な値が含まれていることを確認する必要があります。 これらの詳細は、パッケージを使うときに Bot editorまたは API Task エディターに表示されます。 アクションを追加すると、アクション 設定ページが表示されます。 設定 タブはさまざまな設定を表示し、テスト タブではアクションをテストできます。 設定 タブで使用できる設定は次のとおりです。

構成 タブの設定

HTTP メソッド
送信する必要がある REST リクエストの種類を REST API サーバーに指定してください。 サポートされている HTTP メソッドは以下のとおりです。
  • GET
  • PUT
  • POST
  • DELETE
  • パッチ
注: API定義をインポートすると、コネクタエディタはサポートされていないメソッドのアクションを無視し、残りをカスタムコネクタに含めます。
エンドポイント
このアクションで使用するエンドポイント URL を入力してください。 パッケージユーザーはこの URL を見ることができません。 パスとクエリ パラメーターを URL で囲むために、中括弧 {} を使用します。 例: /{version}/product/{productid}?status={productStatus}
完全なURL
この読み取り専用フィールドは、パッケージを作成する際に入力したベースURLと、エンドポイントフィールドからのエンドポイント URL を組み合わせた自動生成フィールドを表示します。 この URL はパッケージ ユーザーに表示されません。
リクエスト パラメーター
リクエストパラメータは、API サーバーからの応答を識別、並べ替え、フィルタリングすることを可能にします。 パラメータを追加 オプションを使用してリクエスト パラメータを追加します。 パスとクエリ パラメータを追加できます。 パラメータが エンドポイント の URL パスと一致していることを確認してください。 リクエスト パラメーターの追加に関する詳細については、[リクエスト パラメーター]を参照してください。
リクエスト ヘッダー
リクエスト ヘッダーは、リクエストに追加情報を追加することを可能にします。 承認、コンテンツの長さ、コンテンツのタイプ、およびCookieのようなリクエスト ヘッダーを追加できます。 リクエスト ヘッダーの追加の詳細については、[リクエスト ヘッダー]を参照してください。
リクエスト ボディ:
リクエスト ボディでは、リクエスト本文の構造を定義するためにサンプル ペイロードをインポートできます。 ペイロードは、API サーバーでリソースを作成、更新、または削除するために必要な実際のデータです。 アクションが実行されると、リクエストにはこのペイロードが含まれます。 リクエスト ボディの追加の詳細については、[リクエスト本文:]を参照してください。
以下のオプションを選択できます。
  • JSON: このオプションを選択して、リクエストボディ属性をマッピングするための JSON サンプルをインポートします。 リーフ ノードがキャプチャされ、属性のリストとしてここに表示されます。 JSON は、そのキーと値のペア構造で柔軟性を提供します。 リクエスト ボディの JSON オプションの詳細については、[JSON]を参照してください。
  • フォームデータ: このオプションを選択すると、フォームデータ パラメータをリクエスト ボディ属性として追加します。 フォームデータ オプションは、コンテンツタイプを指定してファイルを REST API サーバーにアップロードする際に便利です。 フォームデータ オプションの詳細については、[フォーム データ]を参照してください。
  • フォーム URL エンコード データ このオプションを選択すると、クエリタイプのリクエスト パラメータに似た URL エンコードされたキーと値のペアとして HTML フォームにリクエスト ボディ パラメータを追加できます。 フォーム URL エンコード データ エンコード データに関する詳細は、フォーム URL エンコード データ を参照してください
Response
[レスポンス] オプションでは、レスポンスからサンプル ペイロードをインポートし、Bot editorとAPI Taskエディターで表示する属性を選択できます。 レスポンス パラメータの追加について詳しくは、「レスポンス」をご覧ください。