Simulating a match using REST

Last published : Aug 10, 2026
Related information

Overview

The EBX® Match and Merge Add-on allows you to use a REST service to simulate a match operation. You can simulate a match on existing records, or before creating records to avoid duplicating data. Responses are returned in the JSON format shown below:
{
    rest_simulateMatch_results:[
        {
            "primaryKey": "XXXX",
            "recordLabel": "XXXX",
            "score": "XX.XX"
        },
        etc.
    ]
}

Simulating a match

The following table provides an example of asset URL retrieval:
Method type:
POST
URL pattern 
http://localhost:8080/ebx-addon-daqa/rest/v1/simulate-match/<dataspaceKey>/<datasetName>/<aTablePath>/<primarykey>?login=<user>&password=<password>
Sample URL 
http://localhost:8080/ebx-addon-daqa/rest/v1/simulate-match/BReference/Article/_2E_2Froot_2FArticle/1?login=admin&password=admin

http://localhost:8080/ebx-addon-daqa/rest/v1/simulate-match/BReference/Article/_2E_2Froot_2FArticle?login=admin&password=admin
Request parameters
dataspaceKey: An encoded dataspace key of the user dataspace.
datasetName: An encoded dataset name of the user dataset.
aTablePath: An encoded table path (in the schema).
aRecord: An encoded primary key.
Sample body 
{"content":

               {

                "name": "phap",

                "midlename": "quang",

                "generic": {"ratio": 2.5},

                "offices": ["Ha Noi", "Sai Gon"]

                }

}
Response parameters
primaryKey: The primary key for a record returned as a possible match.
recordLabel: The record's label.
score: The record's matching score.
Sample response 
{

    "rest_simulateMatch_results": [

        {

            "primaryKey": "3",

            "recordLabel": " - yellow",

            "score": 100

        },

        {

            "primaryKey": "2",

            "recordLabel": " - green",

            "score": 100

        }

    ]

}
Note
If you provide a record as input, the matching operation uses its value and not the request body (if one is defined).
When inputting a date/time value, use the following pattern: yyyy-MM-dd'T'HH':mm:ss
When inputting a number value, use the following pattern: XX.xx