Get Match Tokens for an Entity
This API allows you to get the match tokens for the specified entity.
You must have the MDM.Config.BusinessModel resource assigned with the
READ privilege.
Request
GET /reltio/api/{tenantId}/entities/{entityId}/matchTokens?db=true/false&hashTokens=true/false&checkDB=true/false?time={timeInMillis}If the db parameter is set to true, then the tokens
appear in the databaseTokens section. The areEqual flag
shows that the databaseTokens and generatedTokens sections
contain the same values.
If the db parameter is set to false, then the response
contains only the generatedTokens section for the specified entity. The
hashTokens parameter is used to override the value in the tenant
configuration. If the checkDB parameter is set to true, the
actual tokens are used and hashTokens is ignored. The default value of the
checkDB parameter is false. If the time
parameter is specified, it returns the match token phrases built for the entity according to
the entity state and business configuration state at the specified time. If you specify the
time parameter, then the db and checkDB
parameters are ignored and effectively set to false.
checkDB parameter is set to true, it checks for
the following: - Whether each token exists in the database
- Whether the entity identifier is in the token record
- Whether there are over-collisioned tokens
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 is not 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 does not exist, then the request fails with a 404 error.
Response if db=true and checkDB=true
{
"generatedTokens": [
{
"value": "token1",
"existsInDB": true,
"linkedToEntity": true
},
{
"value": "token2",
"existsInDB": true,
"linkedToEntity": true
},
...
],
"databaseTokens": [
{
"value": "token3",
"existsInDB": true,
"linkedToEntity": true
},
{
"value": "token4",
"existsInDB": true,
"linkedToEntity": true
},
...
],
"areEqual": true
}Response if db=false and checkDB=false
{
"generatedTokens": [
{
"value": "token1"
},
{
"value": "token2"
},
...
]
}