API for Matcher on Rule
Use this Matcher API function when you have a rule defined for OneData matcher and want to use the same through REST. You must pass the rule name in the URL as given in the URL format. In the JSON input, you need to pass data to be matched and the candidates against which the data should be matched. This function is applicable only for type OneData Matcher.
In the API input, columnName should be the name of the attribute name defined in rules.
URL
http://host:port/custom_OneData_application_name/rest/OneData_repository_ID/project/DQ/matcher/rule/rule_name
Example: http://apktn121:223/wmonedata/rest/OD98HAPA/Standard%20Project/DQ/matcher/rule/DQAPIBOTH2
Mandatory Input Attributes
Required: | inputDataSet, matchCandidate |
Example of API Syntax
{
"dqConfig":
{
"additionalConfig":
{
}
},
"dqRuleConfig":
{
"rules":
[
{
"ruleName":"Rule1",
"ignoreEmptyFields" : "true",
"inputMappings":
[
{
"attributeName":"BusinessName",
"columnName":"BusinessName",
"additionalMapping":
{
"weightage":3,
"algorithm":"OneData Similarity",
"additionalProperties":
{
"isRequired":"true"
}
}
},
{
"attributeName":"WebSite",
"columnName":"WebSite",
"additionalMapping":
{
"weightage":2,
"algorithm":"OneData Similarity"
}
},
{
"attributeName":"City",
"columnName":"City",
"additionalMapping":
{
"weightage":1,
"algorithm":"OneData Similarity"
}
},
{
"attributeName":"State",
"columnName":"State",
"additionalMapping":
{
"weightage":1,
"algorithm":"OneData Similarity"
}
},
{
"attributeName":"StreetName",
"columnName":"StreetName",
"additionalMapping":
{
"weightage":3,
"algorithm":"OneData Similarity"
}
}
]
},
{
"ruleName":"Rule2",
"ignoreEmptyFields" : "false",
"inputMappings":
[
{
"attributeName":"BusinessName",
"columnName":"BusinessName",
"additionalMapping":
{
"weightage":3,
"algorithm":"OneData Similarity"
}
},
{
"attributeName":"WebSite",
"columnName":"WebSite",
"additionalMapping":
{
"weightage":2,
"algorithm":"OneData Similarity"
}
},
{
"attributeName":"City",
"columnName":"City",
"additionalMapping":
{
"weightage":1,
"algorithm":"OneData Similarity"
}
},
{
"attributeName":"State",
"columnName":"State",
"additionalMapping":
{
"weightage":1,
"algorithm":"OneData Similarity"
}
},
{
"attributeName":"StreetName",
"columnName":"StreetName",
"additionalMapping":
{
"weightage":3,
"algorithm":"OneData Similarity"
}
}
]
},
{
"ruleName":"Rule3",
"ignoreEmptyFields" : "false",
"inputMappings":
[
{
"attributeName":"BusinessName",
"columnName":"BusinessName",
"additionalMapping":
{
"weightage":3,
"algorithm":"OneData Similarity"
}
}
]
}
]
},
"inputDataSet":
{
"rows":
[
{
"columns":
[
{
"name":"BusinessName",
"value":"Software AG Kochi Pvt Ltd"
},
{
"name":"WebSite",
"value":"www.softwareag.com"
},
{
"name":"City",
"value":"Kochi"
},
{
"name":"State",
"value":"Kerala"
},
{
"name":"StreetName",
"value":"28/12 Panampilly Avenue"
}
],
"pkIdentifier":"1"
},
{
"columns":
[
{
"name":"BusinessName",
"value":"Software AG Kochi Pvt Ltd"
},
{
"name":"WebSite",
"value":"www.softwareag.com"
},
{
"name":"City",
"value":"Kochi"
},
{
"name":"State",
"value":"Kerala"
},
{
"name":"StreetName",
"value":"28/12 Panampilly Avenue"
}
],
"pkIdentifier":"2"
}
]
},
"matchCandidate":
{
"rows":
[
{
"columns":
[
{
"name":"BusinessName",
"value":"Software AG Kochi Pvt Ltd"
},
{
"name":"WebSite",
"value":"www.softwareag.com"
},
{
"name":"City",
"value":"Kochi"
},
{
"name":"State",
"value":"Kerala"
},
{
"name":"StreetName",
"value":"28/12 Panampilly Avenue"
}
],
"pkIdentifier":"1"
},
{
"columns":
[
{
"name":"BusinessName",
"value":"Software AG Kochi Pvt Ltd"
},
{
"name":"WebSite",
"value":"www.softwareag.com"
},
{
"name":"City",
"value":"Kochi"
},
{
"name":"State",
"value":"Kerala"
},
{
"name":"StreetName",
"value":"28/12 Panampilly"
}
],
"pkIdentifier":"2"
},
{
"columns":
[
{
"name":"BusinessName",
"value":"Software AG Kochi Pvt Ltd"
},
{
"name":"WebSite",
"value":"www.softwareag.com"
},
{
"name":"City",
"value":"Kochi"
},
{
"name":"State",
"value":"Kerala"
},
{
"name":"StreetName",
"value":"Panampilly Nagar"
}
],
"pkIdentifier":"3"
},
{
"columns":
[
{
"name":"BusinessName",
"value":"Software AG Kochi Pvt Ltd"
},
{
"name":"WebSite",
"value":"www.softwareag.com"
},
{
"name":"City",
"value":"Kochi"
},
{
"name":"State",
"value":"Kerala"
},
{
"name":"StreetName",
"value":""
}
],
"pkIdentifier":"4"
},
{
"columns":
[
{
"name":"BusinessName",
"value":"Software AG Kochi Pvt Ltd"
},
{
"name":"WebSite",
"value":"www.softwareag.com"
},
{
"name":"City",
"value":"Kochi"
},
{
"name":"State",
"value":"Kerala"
}
],
"pkIdentifier":"5"
}
]
}
}