Generate Match Tokens for an Existing Entity

Learn about the Entities API endpoint to get the details of how match tokens for a given entity are generated.

This operation provides information about how the match tokens of a given entity are generated, with the current business and physical configuration. For an overview on matching, see topic Reltio match and merge.

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

Request

GET /reltio/api/<tenantId>/entities/<entityId>/matchTokensDetailed?time={timeInMillis}

For full details of this operation's parameters and options, see this reference on the Developer portal.

If the time parameter (Unix time, for example "1731323471111") is specified, the operation returns the match token phrases built for the entity according to the entity state and business configuration state at the specified time.

Note: When the time parameter is specified, the API results may show some discrepancy based on the following:

The match documents and match tokens are generated on-the-fly because the historical information about match documents and match tokens isn't available.
The explanation is built by using the current state of the API. As a result, if the match or survivorship rules have changed after the specified time, then the results of the explanation might differ from the actual results for the specified time.
If an entity refers to data that may change over time, such as lookups or environment configuration, user preferences, or permissions, then the currently available data or configuration is taken. The auto-generated values might not correspond to the actual ones.
The L3 configuration is selected by the timestamp of the history entry.
If an entity or the tenant configuration doesn't exist, then the request fails with a 404 error.

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 is similar to the response that you get when you generate match tokens for a specific entity.

Accelerate the Value of Data

Generate Match Tokens for an Existing Entity

Footer