Use the Search Match API version 2 to directly search master records that match based on the published match model configuration. The required input parameters for the REST API vary based on the business entity and its match model.
The direct search on master records reduces the processing time and speeds up the match process.
To specify a match model configuration in the Search Match API version 2, use one of the following methods:
•Specify a match model ID and the required fields of the Directed AI match rules in the API.
•Set a default match model for the Search Match API version 2 in Business 360 Console and specify the required fields of the Directed AI match rules in the API.
•Specify at least one field for which you created a Directed AI match rule.
Note: Ensure that the Directed AI match rules of the published match models in Business 360 Console include the required fields.
To search for matching records, submit a POST request with the following URI:
The following table describes the parameters that you specify in the POST request:
Parameter
Type
Description
businessEntity
String
Internal ID of the business entity that contains the published match model. You must have a read access to the business entity.
matchmodel
String
Optional. Unique identifier of the published match model that contains the candidate selection criteria and Directed AI match rules required for matching the records.
If you don't specify a match model, the API uses the default match model that you set for the Search Match API version 2 in Business 360 Console.
2Index the generated match keys in the MDM SaaS data store. For more information about indexing generated match keys, contact Informatica Global Customer Support.
Request body (v2)
The following table describes the parameters in the request body:
Parameter
Type
Description
maxRecordsToReturn
Number
Optional. Maximum number of records to return in the search results.
Default is 100.
searchLevel
String
Optional. Candidate search level that the match model uses to determine how stringently and thoroughly to search for match candidates.
You can configure the following search levels:
- Narrow
- Typical
- Exhaustive
- Extreme
If you do not provide this value, the REST API uses the value from the match model.
fileRecordLimit
Number
Optional. Maximum number of match candidates that the REST API can process for a record. You can set the limit to a maximum of 10,000, which is also the default..
If the match candidates exceed the maximum limit, the REST API might return an empty response.
searchRecord
Array
Contains the search values, such as the required match field identifiers and their values, based on which you want to find the matching records.
Enter the internal identifiers for the required match fields. For example, birthDate and fullName. For more information about finding the required match fields and their identifiers, see Finding details for the request.
Ensure that you have read access to the match fields.
Exact match field values in Directed AI match rules of a match model are case-sensitive. The API returns matching records only when field values match the exact case of the source.
Note: To search for records by specifying a date, ensure that you use the YYYY-MM-DD format.
Finding details for the request (v2)
You must enter identifier details, such as match field identifier and match model identifier, in the REST API request. To get these details, navigate to the Business 360 Console.
Business entity identifier
To view the identifiers for a business entity, open a business entity from Business 360 Console. Click the Actions menu and view the properties, such as display name and internal ID.
The following image shows the Business Entity dialog box with the properties to configure for a Person business entity:
In the image, the business entity has the internal ID c360.person.
Match model version
To view the version of a match model, click the Match tab of a business entity.
The following image shows the version numbers of the sample match models:
Match model identifier
To view the match model identifier, open a match model. The match model identifier appears in the Model Configuration tab
The following image shows the Model Configuration tab that contains the match model identifier:
Match fields and identifiers
To view the required match fields in a match model, open a published match model of a business entity. Click the Adaptive AI Match Model tab and view the match fields.
The following image shows the sample match fields for a published match model:
In the image, you can view the match fields that are part of the match model. Some fields are basic fields and some fields are part of a field group. For example, Address Line 1 and Address Line 2 are part of the Address field group.
The Internal ID column displays the internal identifiers of each match field. For example, the internal identifier for the Full Name field is fullName and for the Address Line 1 field is addressLine1.
When you enter the required match fields for a field group in the Search Match API version 2 request body, specify the internal identifiers for the match fields and the field group in the search record. For example, enter the address details in the following format:
"PostalAddress": [ { "addressLine1": "QUINCE RD"
} ]
Request response (v2)
The request response returns the matching records.
The following table lists the response parameters:
Parameter
Type
Description
searchResult
Object
Contains the matching records.
totalRecords
Number
Total number of matching records that the request returns.
records
Array
Contains all the matching records that are filtered and sorted based on the specified criteria.
fileRecordLimit
Number
Maximum number of match candidates that the Search Match API version 2 can process for a record.
fileRecordCandidatesCount
Number
Number of match candidates that the Search Match API version 2 identifies.
The POST response includes the following _meta parameters:
Parameter
Type
Description
score
Number
The match score of the record.
rank
Number
Ranking of the matching record. Returned if a record is matched using a rank-based rule.
matchRule
String
Threshold value of the match rule. Returned if a record is matched using a threshold-based rule.
businessId
String
Unique business identifier of the master record.
population
String
Certain characteristics of data in the records that you want to match.
data
Object
Data in the master record.
Sample Request (v2)
The following sample request specifies the match fields, such as name, address, and address type, that a published match model uses:
