Generate Match Tokens for a Specific Entity

Information about how match tokens are generated for a specified entity.

This API call provides information about how the match tokens are generated for the specified entity and the specified configuration. The entity must be specified explicitly.

You must have the MDM.Config.BusinessModel resource assigned with the READ privilege.

Request

POST /reltio/tools/matching/tokensExplanation?tenantId=<tenantId>

Body

{
	"entity": {
		"type": "zxc",
		"attributes": []
	},
	"model": {
		"custom business model": ""
	},
	"matchGroups": [
		"configuration/entityTypes/HCP/matchGroups/ByName",
		"configuration/entityTypes/HCP/matchGroups/ById"
	],
	"matchingConfiguration": {
		"generateTokensForExactOrAllNull": true
	}
}

The business model can be customized by using the model field. If the model field is not specified, then the current tenant configuration is used.

You can customize the list of match groups to that must analyzed. By default, all match groups are analyzed.

The part of physical configuration related to match tokens generation can be passed in the matchingConfiguration section to override the current settings.

Response

{
  "matchGroups": [
    {
      "uri": "configuration/entityTypes/HCP/matchGroups/ByName",
      "operands": [
        {
          "operandName": "and",
          "tokensTotal": 2,
          "tokens": [
            "token 1:token 4:token 5",
            "token 2"
          ],
          "operands": [
            {
              "operandName": "exact",
              "values": [
                {
                  "attributeUri": "configuration/uri1",
                  "value": "attribute 1",
                  "ov": true,
                  "cleansed": false
                },
                {
                  "attributeUri": "configuration/uri1",
                  "value": "attribute 2",
                  "ov": true,
                  "cleansed": false
                }
              ],
              "tokensTotal": 2,
              "tokens": [
                "token 1",
                "token 2"
              ],
              "operands": [
                {
                  "operandName": "exact"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "tokensTotal": 123,
  "tokens": [
    "token 1:token 4:token 5",
    "token 2"
  ]
}

The response contains the following information:

The total number of match tokens, the list of match tokens, and an explanation for each match rule.
The match rule part contains the URI of the match rule and the hierarchical structure corresponding to the operands structure in the match rule.
The operands part contains the operand name, attributes participating in the match tokens (for operands like exact, fuzzy), match tokens generated by the operand, and nested operands if any (for operands like and, or).

Accelerate the Value of Data

Generate Match Tokens for a Specific Entity

Footer