処理状況更新API仕様

2023年03月25日 05:28
更新

処理状況更新APIの仕様は以下の通りです。

エンドポイント
- POST https://external.prod.actrecipe.com/process/update-result
処理概要
- ユーザ所有APIでの処理結果をActRecipeに登録する
Request (application/json)
- Headers
  - x-api-key: (「FaaS間連携」レシピのAPIキーは「レシピ説明」に記載しております)
  - Content-Type: application/json
- Attributes
  - execution_id (string, required) : 処理ID。API呼び出し元より連携された値をそのまま指定する。
  - result (boolean, required) : タスクの処理結果。成功であればTrue、失敗であればFalseを指定する。
  - message (string, required) : タスクの処理結果メッセージ。レシピの実行ログに表示する。
  - artifact (json, optional) : 次のタスクに渡す情報。JSON形式で指定する。
- Response 200 (application/json)
  - Attributes
    - - result (boolean, required) : 処理状況の更新結果。
      - message (string, required) : 処理状況の更新結果メッセージ。
- Response 400 (application/json)
  - Attributes
    - result (boolean, required) : 処理状況の更新結果。
    - message (string, required) : 処理状況の更新結果メッセージ。
    - error (string, required) : エラーメッセージ。

FaaS側のアプリケーションの開発仕様は下記のドキュメントを参照してください。

FaaSアプリケーション開発仕様

■関連