EntityHistory

Represents historical information about an object’s changed field values. This object is only available to users with the “View All Data” permission. This object is unavailable beginning with API version 8.0. Use the object-specific History objects instead: CaseHistory, ContractHistory, LeadHistory, OpportunityFieldHistory, OpportunityHistory ProcessInstanceHistory, QuantityForecastHistory, RevenueForecastHistory, or SolutionHistory.

Supported Calls

describeSObjects(), getUpdated(), getDeleted(), query(), retrieve()

Fields

Field	Details
FieldName	Type picklist Properties Filter, Restricted picklist Description ID of the standard or custom field.
IsDeleted	Type boolean Properties Defaulted on create, Filter Description Indicates whether the object has been moved to the Recycle Bin (`true`) or not (`false`). Label is Deleted.
NewValue	Type anyType Properties Nillable Description New value of the modified field.
OldValue	Type anyType Properties Nillable Description Previous value of the modified field.
ParentId	Type reference Properties Filter Description ID of the object that contains the field.
ParentSobjectType	Type picklist Properties Filter, Restricted picklist Description The kind of object that contains the field.

Usage

In API version 7.0 and later, this object works with Case, Contract, and Solution objects:

This object is always read-only in the online application.
When a field is modified, this object records both the old and new field values. There are exceptions to this behavior for certain fields such as long text areas and multi-select picklists. These fields appear in this object to indicate that the field was changed, but the old and new values are not recorded.
Two rows are added to this object when foreign key fields change. One row contains the foreign key object names that display in the online application. For example, “Jane Doe” is recorded as the name of a contact. The other row contains the actual foreign key ID that is only returned to and visible from the API.
Up to a total of twenty fields (standard or custom) can be tracked for a given object.
In the online application, you can specify which fields are tracked or not tracked at any time.
As soon as tracking is turned on for a field, all changes to its value are recorded in the database.
Turning off tracking for a field stops further changes from being recorded, but the history data is not deleted.
Be advised that deleting a custom field also permanently deletes the history data for that custom field.

Object Reference for Salesforce and Force.com

EntityHistory

Supported Calls

Fields

Usage