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.

describeSObjects(), query()

GET

• Type: int
• Properties: Filter, Group, Nillable, Sort
• Description: How many seconds the field history retention job took to complete (whether successful or not).

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The object type that contains the field history that you retained. For custom objects, use the object name.

• Possible values:

  • Account
  • Case
  • Contact
  • Leads
  • Opportunity

• Type: int
• Properties: Filter, Group, Nillable, Sort
• Description: The number of field history rows that a field history retention job has retained.

• Type: dateTime
• Properties: Filter, Sort
• Description: The date and time before which all field history data was retained.

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The start date of the field history retention job.

• 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.

• Possible values:

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