Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

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, the pilot feature copies data to the archive, leaving a duplicate of the archived data in Salesforce. Deletion of data from Salesforce after archiving is available upon request. Status can include: CopyScheduled CopyRunning CopySucceeded CopyFailed CopyKilled NothingToArchive DeleteScheduled DeleteRunning DeleteSucceeded DeleteFailed DeleteKilled