RecordAction

RecordAction オブジェクトへのアクセス権は、関連付けられた親レコードへのユーザのアクセス権によって決まります。

メモ

サポートされているコール

create()、delete()、describeSObjects()、getDeleted()、getUpdated()、query()、retrieve()、undelete()、update()、upsert()

特別なアクセスルール

Summer '20 以降、このオブジェクトにアクセスできるのは、認証された内部ユーザと外部ユーザのみとなります。

項目

項目	詳細
ActionDefinition	型 picklist プロパティ Create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明 API バージョン 44.0 以降を使用する、サービスの Lightning フローの実装では必須。レコードに関連付けるアクションの API 参照名。たとえばフローの API 参照名。FlowDefinition の代わりにこの項目を使用します。クイックアクションを同じ API 参照名のフローと区別するため、すべてのクイックアクションの API 参照名の前に「QuickAction」を追加します。
ActionType	型 picklist プロパティ Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明 API バージョン 46.0 以降を使用する、サービスの Lightning フローの実装では必須。アクションの種別。可能な値は次のとおりです。 `Flow` (デフォルト) `QuickAction` バージョン 46.0 より前のバージョンの API では、この項目は Flow に設定されています。
FlowDefinition	型 picklist プロパティ Create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明 API バージョン 42.0 または 43.0 を使用する、サービスの Lightning フローの実装では省略可能です。API バージョン 44.0 以降を使用する Winter '19 以降へのアップグレードでは、FlowDefinition が ActionDefinition にコピーされます。バージョン 42.0 と 43.0 では、この項目はレコードに関連付けられたフローの API 参照名です。
FlowInterviewId	型 reference プロパティ Create、Filter、Group、Nillable、Sort、Update 説明省略可能。一時停止または完了したフローのフローインタビュー ID。この項目はプロセスビルダーで設定できません。これはリレーション項目です。リレーション名 FlowInterview リレーション種別 Lookup 参照先 FlowInterview
IsMandatory	型 boolean プロパティ Create、Defaulted on create、Filter、Group、Sort、Update 説明省略可能。アクションが必須かどうかを指定します。デフォルト値は false です。実行時に、ユーザが必須のフローを完了せずに閉じようとすると、アラームが表示されます。クイックアクションの場合、アラームは表示されません。メモ
IsUiRemoveHidden	型 boolean プロパティ Create、Defaulted on create、Filter、Group、Sort、Update 説明省略可能。アクションを削除する機能を UI で非表示にするかどうかを指定します。デフォルト値は false です。true の場合、アクションを削除する機能が UI で非表示になります。ただし、アクションは API を使用して削除できます。
Order	型 int プロパティ Create、Filter、Group、Sort、Update 説明必須。このレコードに関連付けられたすべてのアクションの中でのアクションの順序。
Pinned	型 picklist プロパティ Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明必須。アクションをコンポーネントの上部に固定表示するか下部に固定表示するかを指定します。アクションが固定表示されている場合、IsUiRemoveHidden が true に設定されていなければ、ユーザの UI に [削除] オプションが表示されます。可能な値は次のとおりです。 None (デフォルト) Top Bottom
RecordId	型 reference プロパティ Create、Filter、Group、Sort、Update 説明必須。アクションに関連付けられたレコード。46.0 以降では、ほとんどのオブジェクト種別がサポートされています。サポートされているオブジェクトについての詳細は、『Lightning Flow for Service Developer's Guide (サービスの Lightning フロー開発者ガイド)』を参照してください。これはリレーション項目です。リレーション名 Record リレーション種別 Lookup 参照先 Account、Address、Asset、AssetRelationship、AssignedResource、AssociatedLocation、Campaign、CampaignMember、CarePreauth、CarePreauthItem、Case、ChangeRequest、CollaborationGroup、Contact、ContactRequest、Contract、CoverageBenefit、CoverageBenefitItem、EnhancedLetterhead、Incident、Lead、Location、MemberPlan、OperatingHours、Opportunity、Order、PlanBenefit、PlanBenefitItem、Problem、Pricebook2、PricebookEntry、Product2、ProductItem、ProductItemTransaction、ProductRequest、ProductRequestLineItem、ProductRequired、ProductTransfer、PurchaserPlan、PurchaserPlanAssn、RebateMemberAggregateItem、ResourceAbsence、ResourcePreference、ReturnOrder、ReturnOrderLineItem、ServiceAppointment、ServiceResource、ServiceResourceSkill、ServiceTerritory、ServiceTerritoryMember、Shipment、SkillRequirement、SocialPersona、SocialPost、TimeSlot、User、Visit、VoiceCall、WorkOrder、WorkOrderLineItem、WorkType、WorkTypeGroup ChangeRequest、Incident、Problem は、API バージョン 53.0 以降で使用できます。 RebateMemberAggregateItem は、API バージョン 54.0 以降で使用できます。
Status	型 picklist プロパティ Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明必須。アクションの現在の実行状態。可能な値は次のとおりです。 `New` (デフォルト) `Paused` `Complete` `Started` `Unlinked` — フローが一時停止されて、フローインタビューの現在のレコードが変更されたため、アクションのリンクが解除されました。 Paused および Unlinked 状況はクイックアクションには適用されません。この項目はプロセスビルダーで設定できません。

使用方法

RecordAction オブジェクトは Lightning Experience のアクション & おすすめコンポーネントと連携します。この連結オブジェクトを使用して Salesforce Classic のレコードとアクション間のリレーションを作成できますが、そのリレーションは Salesforce Classic に表示できません。

API バージョン 44.0 では、ActionDefinition 項目が追加され、今後のリリースの RecordAction でフローに加えてアクションの他の型をサポートすることができます。API バージョン 44.0 以降では、FlowDefinition 項目が維持され、以前の API バージョンのこの項目を参照するプロセスをサポートします。組織を API バージョン 44.0 以降を使用する Winter '19 以降にアップグレードすると、FlowDefinition 項目が ActionDefinition 項目にコピーされます。今後のリリースでは FlowDefinition は非推奨になるので、代わりに ActionDefinition を使用してください。

メモ

ActionDefinition または FlowDefinition で参照されるアクションが削除されると、RecordAction オブジェクトが削除されます。関連付けられた親レコードが削除されるか、フローが一時停止されて現在のレコードコンテキストが変更されると、RecordAction オブジェクトも削除されます。アクションが完了すると、関連付けられている RecordAction オブジェクトも削除されます。

削除した RecordActions は、ページを更新するとリストから削除されます。

Java の例

次に、RecordAction オブジェクトを使用してフローをレコードに関連付ける方法の例を示します。

1public void associateNewCustomerFlowWithAccount(Account a) {
2   try {
3      RecordAction newRecordAction = new RecordAction();
4      newRecordAction.setRecordId(a.getId());
5      newRecordAction.setActionDefinition(“New_Customer_Flow”);
6      newRecordAction.setOrder(1);
7
8      SaveResult[] results = connection
9            .create(new SObject[] { newRecordAction });
10   } catch (ConnectionException ce) {
11      ce.printStackTrace();
12   }
13}

Salesforce プラットフォームのオブジェクトリファレンス

サポートされているコール

特別なアクセスルール

項目

使用方法

Java の例

データモデル

関連付けられたオブジェクト