API for Matcher
Use this generic API call in order to match data without any OneData configurations. This API is applicable to only the OneData Matcher type.
URL
http://host:port/custom_OneData_application_name/rest/OneData_repository_ID/OneData_Project/DQ/matcher
Example: http://localhost:8080/WMOnedata/rest/OD98HAPA/Standard%20Project/DQ/matcher
Mandatory Input Attributes
Required: | dqRuleConfig (rules), 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"
}
]
}
}
You can describe the API specification using Swagger as shown below:
Swagger Url :http://host:port/custom_OneData_application_name/rest/OneData_repository_ID/OneData_Project/DQ/matcher/swagger
Example: http://localhost:8080/WMOnedata/rest/OD98HAPA/Standard%20Project/DQ/matcher/swagger.