API レシピ - New API Request (新規 API リクエスト) トリガー
このトリガーは、新規 API リクエストを受け取ると、新しい REST API エンドポイントを作成して実行します。設定されたエンドポイントは、API プラットフォームの REST エンドポイントとして、他のレシピやサードパーティのシステムから呼び出せるようになります。
要件
このトリガーを使用するには、以下のことが必要になります。
- API プラットフォーム機能を利用できる。 このオプションが [Tools] メニューに表示されない場合は、カスタマーサクセスマネージャーまでお問い合わせください。
入力
New API request トリガーには、以下の2種類の入力項目があります。
[Request] 入力項目
[Request] セクションの項目は、エンドポイントに送信されるリクエストの構造を定義します。
| 項目 | 説明 |
|---|---|
| Content type | リクエストのデータ形式を定義します。[application/json]、[text/plain]、[multipart/form-data] のいずれかを選択します。大きい添付ファイル (最大5 GB) をアップロードするには、[multipart/form-data] を使用します。 |
| Request header | リクエストヘッダーに含める必要があるパラメータを定義します。 |
| Request schema | リクエスト本体に含める必要がある、予期されるスキーマを定義します。 |
バイナリコンテンツの処理
マルチパート形式のデータには、画像や PDF ファイルなどのバイナリデータが含まれることがあります。これらのファイルは UTF-8エンコード形式である必要があります。Workato レシピの文字列処理は UTF-8に対応しています。
[Response] 入力項目
[Response] セクションの項目は、リクエストに対してエンドポイントから送信されるレスポンスの構造を定義します。
| 項目 | 説明 | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Content type | レスポンスのデータ形式を定義します。空白のままにすると、デフォルトの JSON になります。 | ||||||||
| Response header | レスポンスヘッダーに含まれるパラメータを定義します。 | ||||||||
| Responses | エンドポイントに送信されたリクエストに対して可能なレスポンスを定義します。 この項目には、以下の補足項目もあります。
|
出力
| 項目 | 説明 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Context | API リクエストに関するメタデータです。 この項目には、以下の補足項目もあります。
| ||||||||||||||
| Request | リクエストのコンテンツタイプと本体に関する詳細が含まれます。 この項目には、以下の補足項目もあります。
|
その他のリソース
Last updated: