Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

HistoryRetentionJob

Represents the body of retained data from the archive, and the status of the archived data. Available in API version 29.0 or later.

Supported SOAP API Calls

describeSObjects(), query()

Supported REST API HTTP Methods

GET

Fields

Field Name	Details
DurationSeconds	Type int Properties Filter, Group, Nillable, Sort Description How many seconds the field history retention job took to complete (whether successful or not).
HistoryType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The object type that contains the field history that you retained. Valid values for standard objects are: Account Case Contact Leads Opportunity For custom objects, use the object name.
NumberOfRowsRetained	Type int Properties Filter, Group, Nillable, Sort Description The number of field history rows that a field history retention job has retained.
RetainOlderThanDate	Type dateTime Properties Filter, Sort Description The date and time before which all field history data was retained.
StartDate	Type dateTime Properties Filter, Nillable, Sort Description The start date of the field history retention job.
Status	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Provides the status of the field history retention job. By default, field history tracking copies data to the archive, leaving a duplicate of the archived data in Salesforce. You can delete data from Salesforce manually after it's archived. Status can include: CopyScheduled CopyRunning CopySucceeded CopyFailed CopyKilled NothingToArchive DeleteScheduled DeleteRunning DeleteSucceeded DeleteFailed DeleteKilled

Tooling API

HistoryRetentionJob

Supported SOAP API Calls

Supported REST API HTTP Methods

Fields