GetMatchedRecords returns records that are candidates to match a specified record.
The request contains a package and a record. The response contains a collection of potentially matching records from the specified package.
You can configure GetMatchedRecords requests in all systems when using the Hub Console Audit Manager to audit requests made by external applications. Once auditing for a particular SIF API request is enabled, Informatica MDM Hub captures each SIF request invocation and response in the audit log. For more information, see the
Multidomain MDM Configuration Guide
.
On IBM DB2, you cannot use functions such as TRIM, LTRIM, and RTRIM in the sortCriteria field of the GetMatchedRecords API. The select statement of the GetMatchedRecords API uses ORDER BY clause that cannot be combined with functions such as TRIM, LTRIM, and RTRIM.
State Management
If Hub state is specified in the request (see setRecordStates(ArrayList)), the parent Base Object of the specified package must have state management enabled. For more information about how to enable state management, see the
Multidomain MDM Cleanse Adapter Guide
or the
Multidomain MDM Configuration Guide
.
Use Case
This is the common scenario for using the GetMatchedRecords request:
Fetch the match candidates for a specified record, display them in a UI, and use the merge request to merge the match candidate the user selects
—After using GetMatchedRecords to retrieve candidate matches for a record, you can display the results in a UI for a user. The user can then select a candidate. Use merge to merge the two records.