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

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

describeSObjects()、query()、retrieve()

API バージョン 42.0 以降では delete() を有効にすることもできます。「項目履歴および項目履歴アーカイブの削除の有効化」を参照してください。

特別なアクセスルール

このオブジェクトは常に参照のみです。

項目

項目	詳細
ActionDefinitionApiName	型 string 説明必須。レコードに関連付けられたアクションの API 参照名。クイックアクションを同じ API 参照名のフローと区別するため、すべてのクイックアクションの API 参照名の前に「QuickAction」を追加します。
ActionDefinitionLabel	型 string 説明必須。実行されたアクションの表示ラベル。
ActionType	型 picklist プロパティ Defaulted on create、Restricted picklist 説明必須。レコードに関連付けられたアクションの種別。可能な値は次のとおりです。 `Flow` (デフォルト) `QuickAction`
IsMandatory	型 boolean プロパティ Defaulted on create 説明省略可能。アクションが必須かどうかを指定します。デフォルト値は false です。
LoggedTime	型 dateTime プロパティ Filter、Sort 説明必須。状態の変更が発生したときのタイムスタンプ。
ParentRecordId	型 reference プロパティ Filter、Sort 説明必須。関連付けられたアクションの親レコード。これはリレーション項目です。リレーション名 ParentRecord リレーション種別 Lookup 参照先 Account、Address、Asset、AssetRelationship、AssociatedLocation、Case、ChangeRequest、CollaborationGroup、Contact、ContactRequest、Contract、EnhancedLetterhead、Incident、Lead、Location、OperatingHours、Opportunity、Order、Pricebook2、PricebookEntry、Problem、Product2、ProductItem、ProductItemTransaction、ProductRequest、ProductRequestLineItem、ProductRequired、ProductTransfer、RebateMemberAggregateItem、ResourceAbsence、Scorecard、ServiceAppointment、ServiceResource、ServiceResourceSkill、ServiceTerritory、ServiceTerritoryMember、Shipment、SkillRequirement、SocialPersona、SocialPost、TimeSlot、User、Visit、VoiceCall、WorkType ChangeRequest、Incident、Problem は、API バージョン 53.0 以降で使用できます。 RebateMemberAggregateItem は、API バージョン 54.0 以降で使用できます。
Pinned	型 picklist プロパティ Defaulted on create、Nillable、Restricted picklist 説明省略可能。アクション上部に固定表示するか、下部に固定表示するか、固定表示しないかを指定します。可能な値は次のとおりです。 None Top Bottom
RecordActionId	型 string プロパティ Filter、Sort 説明必須。RecordAction の ID。
State	型 picklist プロパティ Defaulted on create、Restricted picklist 説明必須。アクションの状態。状態が変更されると、履歴イベントのログ出力がトリガされます。可能な値は次のとおりです。 `Started` (デフォルト) `Paused` `Resumed` `Completed` `Unlinked` — フローが一時停止されて、フローインタビューの現在のレコードが変更されたため、アクションのリンクが解除されました。
UserId	型 reference 説明必須。アクションを実行したユーザ。これは多態的なリレーション項目です。リレーション名 User リレーション種別 Lookup 参照先 User

使用方法

RecordActionHistory オブジェクトは、レコードでさまざまな状態を遷移する、アクションのライフサイクルを表します。

RecordActionHistory オブジェクトは Big Object です。このため、同期 SOQL、SOAP API、REST API、Bulk API、または Apex API を使用してこのオブジェクトを読み取る場合、クエリは特定のパターンに従う必要があり、従わない場合は失敗します。クエリは、次のいずれかのパターンと一致する必要があり、複数の項目を使用する場合は、この順序どおりに使用します。

ParentRecordId
ParentRecordId、LoggedTime (DESC)
ParentRecordId、LoggedTime (DESC)、RecordActionId

たとえば、次の SOQL クエリは ParentRecordId、LoggedTime (DESC) のパターンに従っています。

1SELECT ActionDefinitionApiName, User, State FROM RecordActionHistory WHERE
2          ParentRecordId = {CaseId} ORDER BY ParentRecordId, LoggedTime DESC

同期 SOQL クエリは、パターンに従う必要がなく、任意の項目を照会できます。

Apex トリガは Big Object レコードを参照できません。Apex で RecordActionHistory レコードを照会する場合は、SOQL クエリを使用してください。

Java の例

次に、Java での RecordActionHistory の照会方法の例を示します。

1public void queryHBPOs(String parentRecordId) {
2	  try {
3		  SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");
4
5	      // query for the RecordActionHistory associated with ParentRecord
6	      QueryResult queryResults = connection.query("SELECT ActionDefinitionApiName, LoggedTime, State " +
7	      		"FROM RecordActionHistory WHERE ParentRecordId = '" + parentRecordId + "' LIMIT 50");
8	      if (queryResults.getSize() > 0) {
9	        for (int i=0;i<queryResults.getRecords().length;i++) {
10	          // cast the SObject to a strongly-typed RecordActionHistory
11	          RecordActionHistory raa = (RecordActionHistory)queryResults.getRecords()[i];
12	          System.out.println("ActionDefinitionApiName: " + raa.getActionDefinitionApiName() + " - LoggedTime: "+ format.format(raa.getLoggedTime().getTime()) + " - State: " +
13	              raa.getState());
14	        }
15	      }
16	  } catch (Exception e) {
17	      e.printStackTrace();
18	  }
19  }