API for Data Match on Single Rule
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.
The output includes a header; a header section, which includes consolidated details of the number of input data rows, number of 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
inputMappings | Consisting of the following input mapping attributes:  attributeName. Attribute name of the OneData matcher. columnName. Column name in the dataset. additionalMapping. Additional data mapping attributes: weightage. Column weightage. algorithm. Matching algorithm to use. additionalProperties. Key-value pair to use. |
inputDataSet | Consisting of the following attributes for each column within rows: 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. |
Required: | attributeName, columnName, inputDataSet, pkIdentifier |
Optional: | None. |
Output Attributes
matchcandidate | The rows matched for the input attributes. |
Success Response
Error Response
Syntax for Single Rule Data Matching API Request
{
"dqConfig":
{
"additionalConfig":
{
"<key1>":"<value1>",
"<key2>":"<value2>"
}
},
"rule":
{
"inputMappings": //list of input mapping
[
{
"attributeName":"",
"columnName":"",
"additionalMapping":
{
"weightage":"",
"algorithm":”":"",
"additionalProperties":
{
"<key1>":"<value1>",
"<key2>":"<value2>"
}
}
},.................
]
},
"inputDataSet":
{
"rows":
[
{
"columns":
[
{
"name":"",
"value":""
},
],...................
"pkIdentifier":""
},..............................
]
},
"matchCandidate":
{
"rows":
[
{
"columns":
[
{
"name":"",
"value":""
},.................
],
"pkIdentifier":"111"
},...............
]
}
}
Example for Single Rule Data Matching API Request
TBD
Example for Single Rule Data Matching API Output
TBD
