Object Reference for the Salesforce Platform
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
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.
Special Access Rules
This object is always read-only.
Fields
| Field | Details |
|---|---|
| ActionDefinitionApiName |
|
| ActionDefinitionLabel |
|
| ActionType |
|
| IsMandatory |
|
| LoggedTime |
|
| ParentRecordId |
|
| Pinned |
|
| RecordActionId |
|
| State |
|
| UserId |
|
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 DESCAsynchronous 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.
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<queryResults.getRecords().length;i++) {
// cast the SObject to a strongly-typed RecordActionHistory
RecordActionHistory raa = (RecordActionHistory)queryResults.getRecords()[i];
System.out.println("ActionDefinitionApiName: " + raa.getActionDefinitionApiName() + " - LoggedTime: "+ format.format(raa.getLoggedTime().getTime()) + " - State: " +
raa.getState());
}
}
} catch (Exception e) {
e.printStackTrace();
}
}