RecordActionHistory
Represents the lifecycle of a RecordAction as it goes through different states.
Introduced in API version 44.0.
describeSObjects(), query(), retrieve(), delete()
- This object is always read-only.
- Type: string
- Properties: Group
- 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.
- Type: string
- Properties: Group
- Description: Required. The label of the action that took place.
- Type: picklist
- Properties: Defaulted on create, Group, Restricted picklist
- Description: Required. The type of action associated with the record.
- Possible values:
- Flow — Flow
- QuickAction — QuickAction
- Type: boolean
- Properties: Defaulted on create, Group
- Description: Optional. Specifies whether the action is mandatory. The default value is false.
- Type: datetime
- Properties: Filter, Sort
- Description: Required. The timestamp when the state change occurred.
-
Type: reference
-
Properties: Filter, Group, Sort
-
Description:
Required. The parent record for the associated action.
This is a relationship field.
-
Relationship name: ParentRecord
-
Relationship type: polymorphic
-
Refers to: Account, Address, Asset, AssetAccountParticipant, AssetContactParticipant, AssetDowntimePeriod, AssetRelationship, AssignedResource, AssociatedLocation, Campaign, CampaignMember, CarePgmEnrolleeWkOrdStep, CarePreauth, CarePreauthItem, Case, CaseProceeding, ChangeRequest, Claim, ClaimCoverage, ClaimCoveragePaymentDetail, ClaimItem, ClinicalServiceRequest, CollaborationGroup, Contact, ContactRequest, Contract, ContractLineItem, CoverageBenefit, CoverageBenefitItem, CustomEntityDataTemplate, EngagementInteraction, EnhancedLetterhead, Entitlement, Incident, InsurancePolicy, Lead, LiveChatTranscript, Location, LoyaltyProgramMember, MaintenanceAsset, MaintenancePlan, MemberPlan, MessagingSession, OperatingHours, Opportunity, Order, OrderSummary, PgmRebateTypBnftMapping, PlanBenefit, PlanBenefitItem, Pricebook2, PricebookEntry, Problem, Product2, ProductConsumed, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, ProgramRebateTypPayoutSrc, ProgramRebateType, ProgramRebateTypeBenefit, ProgramRebateTypeFilter, ProgramRebateTypePayout, PurchaserPlan, PurchaserPlanAssn, Quote, QuoteLineItem, RebateClaim, RebateClaimAdjustment, RebateMemberAggregateItem, RebateMemberClaimAggregate, RebateMemberProductAggregate, RebatePartnerSpecialPrcTrm, RebatePayment, RebatePayoutAdjustment, RebateProgram, RebateProgramMember, RebateProgramMemberPayout, RebateProgramPayoutPeriod, RebatePtnrSpclPrcTrmBnft, ResidentialLoanApplication, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderLineItem, Scorecard, ServiceAppointment, ServiceContract, ServiceCrew, ServiceCrewMember, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryLocation, ServiceTerritoryMember, Shipment, SkillRequirement, SocialPersona, SocialPost, Tenant, TimeSheet, TimeSheetEntry, TimeSlot, User, Vehicle, VehicleDefinition, Visit, VoiceCall, WorkCapacityLimit, WorkCapacityUsage, WorkOrder, WorkOrderLineItem, WorkType, WorkTypeGroup
-
Type: picklist
-
Properties: Defaulted on create, Group, Nillable, Restricted picklist
-
Description:
Optional. Specifies whether the action is pinned to the top or bottom, or unpinned. Possible values are:
- None
- Top
- Bottom
-
Possible values:
- None — None
- Top — Top
- Bottom — Bottom
- Type: string
- Properties: Filter, Group, Sort
- Description: Required. The ID of the RecordAction.
- Type: picklist
- Properties: Defaulted on create, Group, Restricted picklist
- Description: Required. The state of the action. A state change triggers the logging of a history event.
- Possible values:
- Started — Started
- Paused — Paused
- Resumed — Resumed
- Completed — Completed
- Unlinked — Unlinked — The action was unlinked because the flow was paused and the current record for the flow interview changed.
-
Type: reference
-
Properties: Group
-
Description:
Required. The user that conducted the action.
This is a polymorphic relationship field.
-
Relationship name: User
-
Relationship type: polymorphic
-
Refers to: SelfServiceUser, User
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.
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. Learn more about big objects and how to query them in the Query Big Objects module on Trailhead.
Here’s a Java example of how to query a RecordActionHistory object.