Force.com Tooling API Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

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.

The HistoryRetentionJob object is currently available through a limited pilot program. Contact your salesforce.com representative to see if your organization qualifies.

Note

Supported SOAP API Calls

describeSObjects(), query()

Supported REST API HTTP Methods

GET

Fields

Field Name Details
CreatedById
Type
reference
Properties
Defaulted on create, Filter, Group, Sort
Description
The user ID of the user who created the field history retention job.
CreatedDate
Type
dateTime
Properties
Defaulted on create, Filter, Sort
Description
The date the record was saved.
DurationSeconds
Type
int
Properties
Filter, Group, Nillable, Sort
Description
How many seconds the field history retention job took to complete (either successfully or with failures).
HistoryType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The object type containing the field history you retained. Valid values are:
  • Account
  • Case
  • Contact
  • Leads
  • Opportunity

Custom objects are also valid.
NumberOfRowsRetained
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of field history rows 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 may include:

  • CopyScheduled
  • CopyRunning
  • CopySucceeded
  • CopyFailed
  • CopyKilled
  • DeleteScheduled
  • DeleteRunning
  • DeleteSucceeded
  • DeleteFailed
  • DeleteKilled