Services Integration Framework Guide

10.3 HotFix 3
- 10.5
- 10.4 HotFix 3
- 10.4 HotFix 2
- 10.4 HotFix 1
- 10.4
- 10.3 HotFix 2
- 10.3 HotFix 1
- 10.3

Back Next

Restore

Restore reinstates the specified XREF record(s) in the Hub. Restore changes the state of records from DELETED to ACTIVE state. If an attempt is made to restore an active or pending record, an error is returned. After an XREF record is restored, the state of the parent BO record will be active.

Required Parameters

The following table lists and describes the parameters that are required by the Restore API:

Parameter	Description
SiperianObjectUid	Name and type of the package or base object to be restored.
XrefKey	Key to uniquely identify the record to be restored.
SystemName	Name of the system for which the record must be restored.
SourceKey	Source key of the record that must be restored.

Optional Parameters

The following table lists and describes the optional parameters that are used by the Restore API:

Parameter	Description
PeriodStartDate	This parameter is used to specify the period start date for timeline-enabled objects.
PeriodEndDate	This parameter is used to specify the period end date for timeline-enabled base objects.

Usage Example

The following example restores the XREF record with sourceKey=1234 and system=CRM from the package CUSTOMER_UPDATE. If the XREF record is pending or active, an error will be returned. If the XREF record is deleted, it will be made active.

RestoreRequest request = new RestoreRequest();
XrefKey xrefKey = new XrefKey();
xrefKey.setSourceKey("1234");
xrefKey.setSystemName("CRM");
ArrayList xrefKeys = new ArrayList();
xrefKeys.add(xrefKey);
request.setXrefKeys(xrefKeys); // Required
request.setSiperianObjectUID("PACKAGE.CUSTOMER_UPDATE"); //Required

RestoreResponse response = (RestoreResponse) sipClient.process(request);