API for Data Match on Multiple Rules
Use this REST call to match an input dataset with a set of match candidates by using the pre-defined JSON format. You can include as many input and match dataset rows as required for the datasets to match and as multiple matching rules. OneData executes each rule in the sequence given in the API.
The output returns the match candidate with the greatest score. The output for this REST API call includes a header; a header section, which includes the consolidated details of the number of input data rows, match candidates, status, matcher statistics, repository ID, client ID, user ID and so on; matcher details for each dataset row, which includes the match candidate identifier with the match score, and the success or failure message.
URL
http://host:port/custom_OneData_application_name/rest/OneData_repository_ID/OneData project name/DQ/match
Example: http://apktn121:223/wmonedata/rest/wmmedata/companypartners/DQ/match
Input Attributes
dqRuleConfig | Consisting of the list of rules to apply for matching as an array set. Each rule array should specify the following attributes:  ignoreEmptyFields. with the valid value as either true or false. inputMappings. An array of input mappings that include these attributes: attributeName. Name of the OneData matcher attribute. columnName. Column name of the dataset. additionalProperties. Key-value pair to use. attributeName. Name of the OneData matcher attribute. columnName. Column name of the dataset. additionalMappings. Additional attribute mappings to use: weightage. Column weightage. algorithm. Matching algorithm to use. additionalProperties. Key-value pair to use. |
inputDataSet | Define an array of rows to match: name. Column name. value. Value contained within the column. pkIdentifier. Unique row identifier. You must specify the pkIdentifier for both the input and match candidate data rows for an error-free result. |
| Unique row identifier. |
Required: | , dqRuleConfig, inputDataSet |
Optional: | pkIdentifier |
Output Attributes
matchcandidate | The rows matched for the input attributes. |
Success Response
Error Response
Syntax for Data Matching API Request with Multiple Rules
{
"dqConfig":
{
"additionalConfig":
{
"<key1>":"<value1>",
"<key1>":"<value1>"
}
},
"dqRuleConfig":
{
"rules":
[//array of rules
{
"ignoreEmptyFields" : "<true/false>",
"inputMappings": // array of input mapping
[
{
"attributeName":"",
"columnName":"",
"additionalMapping":
{
"weightage":""
"algorithm":""sed>”,
"additionalProperties":
{
"<key1>":"<value1>",
"<key2>":"<value2>"
}
}
},............
]
},.................
]
},
"inputDataSet":
{
"rows":
[//array or rows
{
"columns":
[//array of columns
{
"name":"",
"value":""
},
],
"pkIdentifier":""
},..............
]
},
"matchCandidate":
{
"rows":
[//array of rows
{
"columns":
[//array of columns
{
"name":"":"",
"value":""
},........
],
"pkIdentifier":""
},.........
]
}
}
Example for Input of Data Matching API Request with Multiple Rules
TBD
Example for Output of Data Matching with Multiple Rules API
TBD
