webMethods OneData 10.11 | Managing Master Data with webMethods OneData | webMethods OneData Consolidation MDM Guide | Using REST APIs for Data Quality Consolidation | Data Quality APIs | API for Matcher on Object
 
API for Matcher on Object
Use this Matcher API function when you have an object-project mapping defined in webMethods OneData, and you want to use the mapping through REST. You must pass the object name in the URL as given in the URL syntax. In the JSON input, you need to pass only the data that needs to be matched along with the match candidates. This API function is applicable to any type of object-project mapping, including a pluggable type matcher.
In the API input, columnName should be the name of object columns used in the project-object mapping.
URL
http://host:port/custom_webMethods_OneData_application_name/rest/
webMethods_OneData_repository_ID/webMethods_OneData_Project/DQ/matcher/object/object_name
Example: http://localhost:8080/WMOnedata/rest/OD98HAPA/Standard%20Project/DQ/matcher/object/AddressConsolidation
Mandatory Input Attributes
Required:
inputDataSet, matchCandidate
Example of API Syntax
{
"dqConfig":
{
"additionalConfig":
{
}
},
"inputDataSet":
{
"rows":
[
{
"columns":
[
{
"name":"Name",
"value":"Software AG Kochi Pvt Ltd"
},
{
"name":"Website",
"value":"www.softwareag.com"
},
{
"name":"City",
"value":"Kochi"
},
{
"name":"State",
"value":"Kerala"
},
{
"name":"Address",
"value":"Panampilly Avenue"
},
{
"name":"BusinesIdentifier",
"value":"111222"
},
{
"name":"BuildingNo",
"value":"28/12"
},
{
"name":"ZipCode",
"value":"682021"
}

],
"pkIdentifier":"1"
},
{
"columns":
[
{
"name":"Name",
"value":"Software AG Kochi Pvt Ltd"
},
{
"name":"Website",
"value":"www.softwareag.com"
},
{
"name":"State",
"value":"Kerala"
},
{
"name":"Address",
"value":"Panampilly Avenue"
},
{
"name":"BusinesIdentifier",
"value":"111222"
},
{
"name":"BuildingNo",
"value":"28/12"
},
{
"name":"ZipCode",
"value":"682021"
}

],
"pkIdentifier":"2"
},
{
"columns":
[
{
"name":"Website",
"value":"www.softwareag.com"
},
{
"name":"City",
"value":"Kochi"
},
{
"name":"State",
"value":"Kerala"
},
{
"name":"Address",
"value":"Panampilly Avenue"
},
{
"name":"BusinesIdentifier",
"value":"111222"
},
{
"name":"BuildingNo",
"value":"28/12"
},
{
"name":"ZipCode",
"value":"682021"
}

],
"pkIdentifier":"3"
}
]
},
"matchCandidate":
{
"rows":
[
{
"columns":
[
{
"name":"Name",
"value":"Software AG Kochi Pvt Ltd"
},
{
"name":"Website",
"value":"www.softwareag.com"
},
{
"name":"City",
"value":"Kochi"
},
{
"name":"State",
"value":"Kerala"
},
{
"name":"Address",
"value":"Panampilly Avenue"
},
{
"name":"Detailidentifier",
"value":"111222"
},
{
"name":"Buildingno",
"value":"28/12"
},
{
"name":"Zipcode",
"value":"682021"
}

],
"pkIdentifier":"111"
},
{
"columns":
[
{
"name":"Name",
"value":"Software AG Kochi Pvt Ltd"
},
{
"name":"Website",
"value":"www.softwareag"
},
{
"name":"City",
"value":""
},
{
"name":"State",
"value":"Kerala"
},
{
"name":"Address",
"value":"Panampilly Avenue"
},
{
"name":"Detailidentifier",
"value":"111222"
},
{
"name":"Buildingno",
"value":"28"
},
{
"name":"Zipcode",
"value":"682021"
}

],
"pkIdentifier":"222"
}
]
}
}
You can describe the API specification using Swagger as shown below:
Swagger URL:
http://host:port/custom_webMethods_OneData_application_name/rest/
webMethods_OneData_repository_ID/webMethods_OneData_Project/DQ/matcher/object/object_name/swagger
Example: http://localhost:8080/WMOnedata/rest/OD98HAPA/Standard%20Project/DQ/matcher/object/AddressConsolidation/swagger.