レスポンス

[応答] アクティビティは API ワークフローを終了し、構造化された応答をリクエスト送信者に送信します。応答には通常、ステータスと追加データが含まれます。

[応答] アクティビティを使用して、以下を実行します。

• 常に正しいステータスと応答の詳細を返します。
• 明確で構造化された結果でワークフローを終了します。
• エラーを適切に処理できます。特に [ トライ/キャッチ ] アクティビティと組み合わせた場合はそうです。

[返信] アクティビティはワークフローの最後のステップにする必要があります。その過程で目的の情報が確実に提供されます。

注:

現在のところ、スキーマの検証は適用されないため、[ 応答 ] アクティビティで返されるデータに含まれるプロパティが、出力スキーマで定義されたプロパティよりも多かったり少なかったりしても、ワークフローが失敗することはありません。

ベスト プラクティス

• Response アクティビティを追加する前に、必ずデータ マネージャーで出力スキーマを設定します。スキーマを最初に定義すると、[ 応答 ] アクティビティをそのスキーマに合わせるよう自動的に提案されます。
• 応答ステップは、Maestro やエージェントなどの呼び出し元が応答を期待している場合に使用します。
• システム間の連携や無人オートメーションを構築する場合は、 応答 の追加をスキップできます。

[応答] アクティビティを使用する

ワークフローに [応答] アクティビティを追加するには、以下の手順を実行します。

1. API ワークフロー デザイナー キャンバスで、プラス (+) アイコンを選択します。[ アクティビティを追加 ] メニューが表示されます。
2. [ 返信] を選択します。
3. [ プロパティ ] パネルで、次のフィールドを設定します。
   • ジョブを失敗としてマーク - このオプションをオンにし、ワークフロー全体を失敗としてマークします。これは、技術的な例外がスローされていなくても、論理エラーが発生したことを明示的に通知する場合に便利です。
   • 応答 — 式エディターを使用して、目的の応答情報を含む JSON オブジェクトを定義します。静的な値や変数を指定することもできます。
4. 設定を保存します。

応答アクティビティの例

次の例では、Workday から従業員を取得し、そのマネージャーと直属の部下に関する詳細を集計します。

次の画像は、ワークフローの例を示しています。

失敗の応答

いずれかの取得手順が失敗すると、このワークフローはエラー メッセージ付きの 失敗 ステータスを返します。

このためには、次の手順に従います。

• 取得ステップを Try/Catch ブロックで囲みます。
• エラーが発生した場合、Catch フローの [エラー対応] ステップは構造化された失敗応答を返します。

応答を次の詳細で設定します。

• タイプ - 失敗
• [詳細] - [式エディター] を開き、以下を書き込みます。

  ({
      "error_message": $context.outputs.Try_Catch_3.error.title,
      "status": $context.outputs.Try_Catch_3.error.status
  })
  

ここでは、[トライ キャッチ] アクティビティからの構造化されたエラー出力$context.outputs.Try_Catch_3.error提供されます。Try フローの実行中にエラーが発生すると、ワークフローは次の出力を返します。

成功の応答

ワークフローは、集約された従業員情報を含む 成功 ステータスを返します。[ 従業員を名前または ID で検索 ] アクティビティは、一致する配列が 1 つしかない場合でも配列を返します。そこでは、[繰り返し ( コレクションの各要素 )] アクティビティを使用して各結果を処理し、[ スクリプト ] アクティビティを使用してデータを統合します。

応答を次の詳細で設定します。

• タイプ - 成功
• [詳細] - [式エディター] を開き、以下を書き込みます。

  ({
      "workers": $context.outputs.For_Each_2.results
  })
  

ここで、workers には、[繰り返し (コレクションの各要素)] ループの [スクリプト] ステップから集計された出力が含まれています。このワークフローでは、次の出力が返されます。