--- schema_version: "1" id: aeed8c3747d93dc481466246b2fff9331a82397fd2b6a74b62150e5966c959d6 title: RecordActionHistory collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_recordactionhistory.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_recordactionhistory.htm source_site: developer.salesforce.com content_type: documentation content_hash: e080801228c077ee9c8140791cfa897d26998e6922c9dbf468a53f5a51363196 description: Represents the lifecycle of a RecordAction as it goes through different states. Available in API version 44.0 and later. --- # RecordActionHistory Represents the lifecycle of a RecordAction as it goes through different states. Available in API version 44.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() You can also enable delete() in API version 42.0 and later. See [Enable delete of Field History and Field History Archive](https://help.salesforce.com/articleView?id=000321814&type=1&mode=1&language=en_US "HTML (New Window)"). ## Special Access Rules This object is always read-only. ## Fields | Field | Details | | --- | --- | | ActionDefinitionApiName | Type string Description Required. The API name of the action associated with the record. To distinguish a quick action from a flow with the same API name, we prepend "QuickAction" to the API name of every quick action. | | ActionDefinitionLabel | Type string Description Required. The label of the action that took place. | | ActionType | Type picklist Properties Defaulted on create, Restricted picklist Description Required. The type of action associated with the record. Possible values are: - Flow (default) - QuickAction | | IsMandatory | Type boolean Properties Defaulted on create Description Optional. Specifies whether the action is mandatory. The default value is false. | | LoggedTime | Type dateTime Properties Filter, Sort Description Required. The timestamp when the state change occurred. | | ParentRecordId | Type reference Properties Filter, Sort Description Required. The parent record for the associated action. This is a relationship field. Relationship Name ParentRecord Relationship Type Lookup Refers To 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 are available in API version 53.0 and later. RebateMemberAggregateItem is available in API version 54.0 and later. | | Pinned | Type picklist Properties Defaulted on create, Nillable, Restricted picklist Description Optional. Specifies whether the action is pinned to the top or bottom, or unpinned. Possible values are: - None - Top - Bottom | | RecordActionId | Type string Properties Filter, Sort Description Required. The ID of the RecordAction. | | State | Type picklist Properties Defaulted on create, Restricted picklist Description Required. The state of the action. A state change triggers the logging of a history event. Possible values are: - Started (default) - Paused - Resumed - Completed - Unlinked—The action was unlinked because the flow was paused and the current record for the flow interview changed. | | UserId | Type reference Description Required. The user that conducted the action. This is a polymorphic relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## Usage The RecordActionHistory object represents the lifecycle of an action on a record as it goes through different states. The RecordActionHistory object is a big object. For this reason, when you use synchronous SOQL, SOAP, REST, Bulk, or Apex APIs to read this object, queries must follow a specific pattern or they fail. Queries must match one of these patterns and use fields in this precise order when more than one field is used. - ParentRecordId - ParentRecordId, LoggedTime (DESC) - ParentRecordId, LoggedTime (DESC), RecordActionId For example, this SOQL query follows the ParentRecordId, LoggedTime (DESC) pattern. SELECT ActionDefinitionApiName, User, State FROM RecordActionHistory WHERE ParentRecordId = {CaseId} ORDER BY ParentRecordId, LoggedTime DESC Asynchronous SOQL queries do not need to follow a pattern, and can query any field. Apex triggers cannot reference big object records. Use SOQL queries if you want to query RecordActionHistory records in Apex. For more information about the Actions & Recommendations component and how it works with RecordActions, see the [Lightning Flow for Service Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.salesforce_guided_engagement.meta/salesforce_guided_engagement/salesforce_guided_engagement.htm "HTML (New Window)"). Learn more about big objects and how to query them in the _[Query Big Objects](https://trailhead.salesforce.com/en/modules/big_objects/units/big_objects_querying "HTML (New Window)")_ module on Trailhead. ## Java Example Here’s a Java example of how to query a RecordActionHistory object. public void queryHBPOs(String parentRecordId) { try { SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd"); // query for the RecordActionHistory associated with ParentRecord QueryResult queryResults = connection.query("SELECT ActionDefinitionApiName, LoggedTime, State " + "FROM RecordActionHistory WHERE ParentRecordId = '" + parentRecordId + "' LIMIT 50"); if (queryResults.getSize() > 0) { for (int i=0;i