APIレシピを作成 ​

トリガーのリクエストセクションに移動します。

コンテンツタイプドロップダウンメニューを使用して、エンドポイントが受け入れるデータの種類を選択します。 たとえば、application/jsonを選択すると、エンドポイントは有効なJSONデータを受け入れます。

任意です。 リクエストヘッダーセクションを使用して、リクエストヘッダーで受け入れるパラメーターを定義します。

任意です。 パスパラメーターセクションを使用して、JSONおよびText/XMLリクエストのエンドポイントパスで受け入れるパラメーターを定義します。 サンプルJSONファイルをアップロードするか、フィールドを手動で入力できます。

リクエストスキーマセクションを使用して、JSONおよびMultipartリクエストのリクエスト本文のスキーマを定義します。 サンプルJSONファイルをアップロードするか、フィールドを手動で入力できます。

トリガーのレスポンスセクションに移動します。

コンテンツタイプドロップダウンメニューを使用して、レスポンスで送信するデータの種類を選択します。

任意です。 レスポンスヘッダーセクションを使用して、レスポンスヘッダーで送信するパラメーターを定義します。

レスポンスセクションに移動し、レスポンスを追加を選択します。

レスポンス#1セクションでレスポンスの名前を指定します。

HTTPステータスコードドロップダウンメニューを使用して、レスポンスのコードを選択します。 または、入力フィールドを標準レスポンスからカスタムレスポンスに切り替え、2xxから5xxまでのカスタムHTTPステータスコードを入力できます。

レスポンスセクションを使用して、レスポンス本文のスキーマを定義します。 サンプルJSONファイルをアップロードするか、フィールドを手動で入力できます。

ルートを含む親の間でプロパティをドラッグアンドドロップすることで、ネストされたスキーマレスポンスを作成できます。 または、スキーマを編集ボタンをクリックし、使用する予定のネストされたスキーマを指定します。

レスポンススキーマ

[
  {
    "name": "Accounts",
    "type": "array",
    "of": "object",
    "label": "Accounts",
    "optional": false,
    "hint": "Found Salesforce accounts",
    "properties": [
      {
        "control_type": "text",
        "label": "ID",
        "name": "ID",
        "type": "string",
        "optional": false,
        "hint": "Account ID"
      },
      {
        "control_type": "text",
        "label": "Name",
        "name": "Name",
        "type": "string",
        "optional": false,
        "hint": "Account name"
      }
    ]
  }
]

APIエンドポイントを通じて公開する予定のアクションを、エラーを監視するアクションブロック内に追加します。 アプリの具体的なコネクションおよび設定手順については、コネクターのドキュメントを参照してください。

エラーを監視するアクションを追加

+ステップを追加＞アプリ内のアクションをクリックします。

API platform by Workatoを検索して選択します。

操作でエラーが発生しない場合に送信するレスポンスの種類を、レスポンスドロップダウンメニューを使用して選択します。 このメニューのオプションは、レシピの新規APIリクエストトリガーで定義されたレスポンスによって決まります。

IF条件を使用すると、レシピデータに基づいて異なるレスポンスを送信できます。

レシピでエラーが発生しない場合にレスポンス本文で返すデータを設定するには、レスポンス本文セクションを使用します。 このセクションの構造は、新規APIリクエストトリガーで定義されたスキーマに基づいて異なります。

レシピでエラーが発生しない場合にレスポンスヘッダーで返すデータを設定するには、レスポンスヘッダーセクションを使用します。 このセクションの構造は、新規APIリクエストトリガーで定義したスキーマに基づいて異なります。

Error found?ブロックでDo not retryを選択します。

Monitorブロックのアクションを再試行しますか?ドロップダウンメニューを使用して、失敗したアクションを再試行する回数を選択します。 Workatoでは最大3回まで再試行できます。

Select an app and actionをクリックします。

API platform by Workatoを検索して選択します。

操作でエラーが発生した場合に送信するレスポンスの種類を、レスポンスドロップダウンメニューを使用して選択します。 このメニューのオプションは、レシピの新規APIリクエストトリガーで定義したレスポンスによって決まります。

IF条件を使用すると、レシピデータに基づいて異なるレスポンスを送信できます。

レシピでエラーが発生した場合にレスポンス本文で返すデータを設定するには、レスポンス本文セクションを使用します。 このセクションの構造は、新規APIリクエストトリガーで定義したスキーマに基づいて異なります。

レシピでエラーが発生した場合にレスポンスヘッダーで返すデータを設定するには、レスポンスヘッダーセクションを使用します。 このセクションの構造は、新規APIリクエストトリガーで定義したスキーマに基づいて異なります。