Unarchive Apex

By unarchiving the record, you unarchive the whole hierarchical tree of any root or child records related to it.

Note Unarchive isn't processed if the search result contains more than 1,000 records.

Note Unarchive requests via Apex are limited to 50 per hour for each org.

Prerequisites:

Archive Enable Unarchive—Unarchive records from the Archive, or via Apex.

If you need only one unarchive permission, you can enable one of these custom permissions, and then manually assign it to a custom permission set or profile.

• Archive Unarchive—Permission to unarchive records from Archive only.
• Archive Unarchive SDK—Permission to unarchive records via Archive Apex only.

Unarchive Apex Functions

You can search one object per unarchive request and apply a maximum of 6 filters to the search.

1. performUnarchiveSdk(string sObjectName, list<SearchFilter> filters, DateRange dateRange)
2. performUnarchiveSdk(string sObjectName, list<SearchFilter> filters)

Apex Parameters

sObjectName—The object queried by Apex.

This parameter is mandatory.

Search Filters—Filters that narrow search results based on field conditions.

• Field Name—The field that you want to filter by, such as Name or CreatedDate.
• Value or List of Values—The specific value or values that you want to match.

  If using a list of values, Apex Data Queries are queried with OR between the values.

This parameter is mandatory.

Date Filters—If you want to search based on dates, use the DateRange parameter and the mandatory filters. DateRange filters records by fields such as ArchiveDate, CreatedDate, and ModifiedDate.

Date filter recommendations:

• To search based on the Archive Date, add the archive_date date field.
• Use the Apex date format: MM/DD/YYYY.

This parameter is optional.

Returned Values

• Request ID of the unarchive operation performed
• Total number of records retrieved by search
• Status code, including errors.

Return Value: ArchiverAccessorResponse

1. ArchiverAccessorResponse.getBody(); ⇒ string
2. ArchiverAccessorResponse.getStatusCode();⇒ string
  a. 200 - if we accepted your request
  b. 400 - if we did not accept your request
3. ArchiverAccessorResponse.getErrorMessage();⇒ string

Note Unarchive Apex can run up to 10 unarchive actions simultaneously. Both Undo and Apex Unarchive are considered unarchive actions.

Code Documentation

performUnarchiveSdk(string sObjectName, list<SearchFilter> filters, DateRange dateRange)

performUnarchiveSdk(string sObjectName, list<SearchFilter> filters)

Return Value: ArchiverAccessorResponse

1. ArchiverAccessorResponse.getBody(); ⇒ string
2. ArchiverAccessorResponse.getStatusCode();⇒ string
  a. 200 - if we accepted your request
  b. 400 - if we did not accept your request
3. ArchiverAccessorResponse.getErrorMessage();⇒ string

Apex Unarchive Code Example

Example 1: Unarchive Accounts named Own.

list<SearchFilter> request = new list<SearchFilter>();
string sObjectName = 'Account';
SearchFilter filter1 = new SearchFilter('Name', 'Own');
request.add(filter1);
ArchiverAccessorResponse res = ArchiverAccessor.performUnarchiveSdk(sObjectName, request);
Map<String, Object> jsonMap = (Map<String, Object>) JSON.deserializeUntyped(res.getBody());

system.debug(jsonMap.get('request_id'));
system.debug(jsonMap.get('total_result_count'));

Example 2: Unarchive Accounts with a filter, where name is PersonAccount3 and the date range is records created in the last 150 days.

// Initialize a list to hold search filters for the archive operation
list<SF_Archive.SearchFilter> request = new list<SF_Archive.SearchFilter>();

// Define the Salesforce object name to perform the operation on
string sObjectName = 'Account';
                
// Create a search filter based on the 'Name' field with a specific value
SF_Archive.SearchFilter filter1 = new SF_Archive.SearchFilter('Name', 'PersonAccount3');
                
// Add the created filter to the request list
request.add(filter1);
                
// Create a date range filter to select records created in the last 150 days
// It calculates the start date by subtracting 150 days from today's date
SF_Archive.dateRange range = new SF_Archive.dateRange('CreatedDate', system.today()-150, system.today());
                
// Perform the unarchive operation with the specified object name, filters, and date range
// This retrieves records from the archival that match the given criteria
SF_Archive.ArchiverAccessorResponse res = SF_Archive.ArchiverAccessor.performUnarchiveSdk(sObjectName, request, range);

// Deserialize the JSON response body to a Map object to easily access the data
Map<String, Object> jsonMap = (Map<String, Object>) JSON.deserializeUntyped(res.getBody());
                
// Debug print the request ID and total result count from the response for logging purposes
system.debug(jsonMap.get('request_id'));
system.debug(jsonMap.get('total_result_count'));