Get the Match Document for an Entity

This API allows you to get the match document for the specified entity.

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

Request

GET /reltio/api/{tenantId}/entities/{entityId}/matchDocument?db=true?time={timeInMillis}

If the db parameter is set to true, then the match document information is displayed in the databaseDocument section. The areEqual flag shows that the generatedDocument and databaseDocument sections contain the same values.

If the db parameter is set to false, then the result contains only the generatedDocument section that has information about the match document generated on the fly for the specified entity, tokens generated by the document, and entity version. If the time parameter is specified, it returns the match document 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 parameter is ignored and effectively set to false.

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 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

{
  "generatedDocument": {
    "document": {
      "Address": [
        {
          ...
        }
      ],
      "FirstName": [
        ...
      ],
      ...
    },
    "tokens": [
      "token1",
      "token2",
      ...
    ],
    "version": 1000000002
  },
  "databaseDocument": {
    "document": {
      "Address": [
        {
          ...
        }
      ],
      "FirstName": [
        ...
      ],
      ...
    },
    "tokens": [
      "token3",
      "token4",
      ...
    ],
    "version": 1000000002
  },
  "areEqual": true
}

Response if db=false

{
  "generatedDocument": {
    "document": {
      "Address": [
        ...
      ],
      "FirstName": [
        ...
      ],
      ...
    },
    "tokens": [
      "token1",
      "token2",
      ...
    ],
    "version": 1000000002
  }
}

Unify and manage your data

Get the Match Document for an Entity

Footer