Request Parameters

TableName

Specifies the base object table name. Required.

SourceTableName

Specifies the name of the table that contains the list of cross-reference records to delete. Required.

Cascading

Determines if the batch delete is cascading. Set to

true

to run a cascading batch delete. Optional.

RecalculateBVT

Determines if the BVT is recalculated. Set to

true

to recalculate BVT after a batch delete. Optional.

OverrideHistory

Determines if the MDM Hub records the activity performed by the batch delete in the history tables. Set to

true

to record the history of deleted records in the history table. Set to

false

to ignore the value of PurgeHistory and write the last state of the data into the history tables when the record is deleted. Optional.

PurgeHistory

Determines if the MDM Hub deletes all non-merge history records related to deleted cross-reference record. You cannot retrieve the deleted history records. Set to

true

to delete the history records. Set to

false

to retain the history records. Optional.

Response Fields

InteractionId

Contains the interaction ID.

Message

Contains a message regarding the status of the request.

RetCode

Contains the return code.

Usage Example

SiperianClient sipClient = SiperianClient.newSiperianClient(new File( context.getTestPTTStartDir() + "siperian-client.properties" ) );
 ExecuteBatchDeleteRequest req = new ExecuteBatchDeleteRequest();
 req.setTableName(jobContext.getTableName());                    // Base object table name
 req.setSourceTableName(jobContext.getSourceTableName());        // The table that contains a  list of cross-reference records to delete
 ExecuteBatchDeleteResponse executed = (ExecuteBatchDeleteResponse) sipClient.process( req );
 String errMessage = executed.getMessage();
 int rc = executed.getRetCode();