この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Action Link

アクションリンクの status の情報取得や更新を行います。アクションリンクの status と Action Link Definition Input の labelKey プロパティの組み合わせにより、UI に表示されるテキストが決まります。Api および ApiAsync アクションリンクの API 要求をトリガするには、status を PendingStatus に設定��ます。

この画像には 2 つのアクションリンクがあります。この画像では、両方のアクションリンクの status が NewStatus です。 UI のアクションリンク

Pam Smith が [確認] をクリックすると、アクションリンク status が SuccessfulStatus に設定され、その結果、この画像のフィード項目が表示されます。 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 に設定する時期は、アプリケーションで決定する必要があります。

次の場合、アクションリンクの status に対する PATCH 要求はできません。

別の status から NewStatus に戻す。
最終的な status (FailedStatus または SuccessfulStatus) から NewStatus または PendingStatus に変更する。
アクションリンクが属するアクションリンクグループの executionsAllowed プロパティが Unlimited である。
Api または ApiAsync アクションリンクの executionsAllowed プロパティが Once の場合、ユーザが初めて PATCH を実行して status を PendingStatus に設定すると、アクションリンクへのコールアウトが行われます。同じユーザが PATCH を実行して状況を PendingStatus に再度設定すると、Salesforce から現在のアクションリンクの情報が返されます。ただし、別のユーザが PATCH を実行して状況を PendingStatus に設定すると、エラーが発生します。いずれの場合も、アクションリンクへのコールアウトは再送信されません。

メモ

リソース

1/connect/action-links/actionLinkId

1/connect/communities/communityId/action-links/actionLinkId

適用開始バージョン

33.0

Chatter が必要かどうか

いいえ

HTTP メソッド

GET、PATCH、HEAD

PATCH のリクエストボディ

ルート XML タグ

<actionLink>

JSON の例

1{  "status" : "SuccessfulStatus"  }

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
`status`	String	アクションの現在の実行状況。値は次のとおりです。 `FailedStatus` — アクションリンクの実行に失敗しました。 `NewStatus` — アクションリンクの実行の準備が整っています。`Download` および `Ui` アクションリンクでのみ使用できます。 `PendingStatus` — アクションリンクが実行されています。この値を選択すると、`Api` および `ApiAsync` アクションリンクの API コールがトリガされます。 `SuccessfulStatus` — アクションリンクが正常に実行されました。	必須	33.0

PATCH の要求パラメータ

名前	型	説明	使用可能なバージョン
`status`	String	値は次のとおりです。 `FailedStatus` — アクションリンクの実行に失敗しました。 `NewStatus` — アクションリンクの実行の準備が整っています。`Download` および `Ui` アクションリンクでのみ使用できます。 `PendingStatus` — アクションリンクが実行されています。この値を選択すると、`Api` および `ApiAsync` アクションリンクの API コールがトリガされます。 `SuccessfulStatus` — アクションリンクが正常に実行されました。	33.0

GET または PATCH のレスポンスボディ

Platform Action

PATCH の例

1PATCH /connect/action-links/0AnRR0000004CTS0A2?status=FailedStatus

Connect REST API 開発者ガイド

Action Link