Services Integration Framework Guide

10.3

Back Next

Delete

The Delete request sets the record state to DELETED on the specified records from the Hub. If you specify the deleteBORecord flag, then the BO record is deleted even if only a sourceKey and systemName are specified.

State Management

When an XREF record is deleted, the state of the BO record will be calculated as the greatest of the states of its XREFs. The order of precedence for state is ACTIVE, PENDING, DELETED. The following list describes the behavior of this request based on various XREF states:

Active records will be transitioned to the DELETED state.

Pending records will be hard deleted.

Deleted records will remain unchanged.

Required Parameters

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

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

Optional Parameters

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

Parameter	Description
deleteBORecord	If true , the record is deleted at the base object level. The Delete API deletes the base object record and all its cross-reference records. You must have delete privileges for the base object or the parent base object. If false , the Delete API deletes the record specified by the RecordKey and SourceKey parameters.
deleteAsSMOS	If true , the hub state of the record is set to deleted by the state management override system, and this takes precedence over active records from other source systems. Default is false.

Use Case

Record A has two XREFs that are ACTIVE. If one of the XREFs is deleted, then record A will have one ACTIVE xref and one DELETED XREF. Since the ACTIVE state has higher precedence than the DELETED state, the state of BO record A after the delete operation is ACTIVE. If the remaining ACTIVE XREF is then deleted, record A will have two deleted XREFs and the state of BO record A will be DELETED.

Usage Example

The following example deletes the XREF record with sourceKey=1234 and system=CRM from the package CUSTOMER_UPDATE. If the XREF record is PENDING, it will be hard deleted. If the XREF record is ACTIVE, it will be soft deleted. If the record is already in the DELETED state, the record will remain as is.

Delete throws an exception if you attempt to delete a record that is in the DELETED state.

DeleteRequest request = new DeleteRequest();
RecordKey recordKey = new RecordKey();
recordKey.setSourceKey("1234");
recordKey.setSystemName("CRM");
ArrayList recordKeys = new ArrayList();
recordKeys.add(recordKey);
request.setRecordKeys(recordKeys); // Required
request.setSiperianObjectUID("PACKAGE.CUSTOMER_UPDATE"); //Required
DeleteResponse response = (DeleteResponse) sipClient.process(request);