Connect REST API 開発者ガイド
jアクションリンクの状況を更新するかアクションリンクを呼び出す
アクションリンクの状況を更新するかアクションリンクを呼び出します。
- 使用方法
- このリソースを使用して、アクションリンクの status プロパティを更新します。Api または ApiAsync アクションリンクを呼び出すには、状況を PendingStatus に設定します。アクションリンクの status と Action Link Definition Input の labelKey プロパティの組み合わせにより、UI に表示されるテキストが決まります。
-
さまざまな種別のアクションリンクには、さまざまな status ワークフローを指定できます。
- Api
- アプリケーションから Api アクションリンクを呼び出すには、PATCH 要求を実行してリンクを PendingStatus としてマークします。Salesforce により、Action Link Definition Input で指定された actionUrl へのコールアウトが処理されます。Api アクションリンクの場合、Salesforce がサーバから返された HTTP 状況コードに基づいて status を SuccessfulStatus または FailedStatus に設定します。
- ApiAsync
- アプリケーションからこのアクションリンクを呼び出すには、PATCH 要求を実行してリンクを PendingStatus としてマークします。Salesforce により、Action Link Definition Input で指定された actionUrl へのコールアウトが処理されます。ApiAsync アクションリンクの場合、コールアウトによってサーバでの非同期操作が開始されます。Salesforce により status が PendingStatus に設定されます。ただし、コールでエラー状況コードが返された場合は、status は FailedStatus に設定されます。非同期処理を終了したサーバは、アクションリンクをコールバックし、PATCH を実行してアクションリンクを SuccessfulStatus または FailedStatus に設定します。
- Download と Ui
- Platform Action レスポンスボディの actionUrl のリンクから、ユーザにダウンロードや UI アクセスを行わせます。PATCH 要求を実行して status を SuccessfulStatus または FailedStatus に設定する時期は、アプリケーションで決定する必要があります。
- リソース
- /connect/action-links/actionLinkId
- HTTP メソッド
- PATCH
- リクエストボディ
- Action Link Input
- リクエストボディの例
-
1{ "status":"SuccessfulStatus" } - 要求パラメータ
- status
- 要求パラメータの例
-
1/services/data/v59.0/connect/action-links/actionLinkId?status=SuccessfulStatus - 戻り値
- Platform Action