カスタムアクションの実行（まだ実装されていません）

最終更新日： 2024年2月5日

トピック：

作成対象：

開発者

このエンドポイントを使用すると、Adobe Workfront ユーザー（または自動ワークフローイベント）が外部システムでアクションを実行できます。 /customAction エンドポイントは、「name」パラメーターを受け取ります。これにより、web フックプロバイダーは複数のカスタム操作を実装できます。

Web フックプロバイダーでは、カスタムアクションを /serviceInfo 応答の customActions 下に含めることで、Workfront に登録します。設定／ドキュメント／カスタム統合で web フックプロバイダーを設定または更新すると、Workfront がこのリストを読み込みます。

ユーザーは、「ドキュメントアクション」の下のセクションを選択することで、カスタムアクションをトリガーできます。

URL

GET /customAction

クエリパラメーター

名前	説明
名前	実行するアクションのタイプを指定する識別子。この値は、/serviceInfo エンドポイントから返される customAction 値のうちの 1 つに対応します。
documentId	アクションの実行対象となる Workfront ドキュメントの ID。
documentVersionId	アクションの実行対象となる Workfront ドキュメントのバージョン ID。

応答

成功または失敗を示す JSON 文字列（この後の「エラー処理」の節を参照）。失敗（status = "failure"）の場合、Workfront は、用意されているエラーメッセージをユーザーに表示します。

例：

https://sample.com/webhooks/customName?name=archive&documentId=5502082c003a4f30 ddec2fb2b739cb7c&documentVersionId=54b598a700e2342d6971597a5df1a8d3

応答

{
status: "success"
}

recommendation-more-help