home

Developer resources

ReltioProductsDeveloper resourcesRolesApplicationsObjectives
ReltioProductsDeveloper resourcesRolesApplicationsObjectives

Unify and manage your data

Show Contents

thumbnailDeveloper resources

Potential matches API

Get transitive matches

Learn to get details of all potential matches based on rules in the entity type configuration.

Transitive matches are marked differently and have the shortest transitive path to the initial entity.

Request

GET {TenantURL}/entities/{entity object URI}/_transitiveMatches

Parameters

Parameter Required Description
Headers Authorization Yes Information about authentication access token in the format "Bearer <accessToken>" (see details in Authentication API).
Query showPath No Specifies if shortest transitive path must be returned. Default value is true.
max No Defines maximum number of returned matches (for each entity).
options No Comma-separated list of different options that affect the entity's JSON content in the response. Available options:
  • ov=false- disabled by default, entity's JSON includes hidden attributes if this option is enabled.
  • ovOnly- returns only attribute values that have ov=true flag.
  • nonOvOnly- returns only attribute values that have ov=false flag. If you have a nested or reference attribute value where ov=true, but subattributes where ov=false, then these subattributes don’t appear in the response.
activeness No When set to active, only active entities are listed in the response for the potential matches. Otherwise, all entities are listed as potential matches.
sort No Name of the property that must be used for sorting. Possible values:
  • score- the match score is used for sorting;
  • relevance or relevanceScores.relevance- the results are sorted based on the relevance score; If this option is enabled, the match action label is added to the response from the match group configuration.
  • attributes.<attribute_name>- the result is sorted based on the attribute value (OV only).

  • actionLabel or relevanceScores.actionLabel- the results are sorted based on the match action label corresponding to the relevance value.

    Sort by relevance.relevanceScores if you want to list entities based on their relevance score. The relevance score is the absolute score between a pair of potential matches. For example, using the relevance-based rule type:

    • Entity pairs John and Johnny match with a relevance score of 0.7.

    • Entity pairs John and Joanna match with a relevance score of 0.35

      Based on whether you sort the scores by ascending or descending order, the potential matches for John shows either Joanna or Johnny first.

    Sort by actionLabel if you want to list entity pairs based on an assigned action label. For example, an action label is assigned to a relevance score range between 0.2 to 0.8. Since both these entity pairs fall under the same relevance score range, they are assigned the same action label and are sorted accordingly.

If this parameter is not defined or if the value can't be recognized, then no sorting is used.
order No Order of sorting. Applicable only with "sort" parameter. Possible values:
  • asc- the results are shown in ascending order;
  • desc- the results are shown in descending order;
Default sorting is desc.
deepNoLimits the depth of transitive matches. Default is 5.
showObjectNoURI of an entity to show a page on which this entity must be present.
markMatchedValuesNoWhen it is set to true, URIs of the matched attributes are available in the output. Default value is false.
typeNoFilter potential matches based on the type of match group. Available values:
  • automatic- filters records that were matched automatically.
  • relevance_based- filters records that were matched based on relevance.
  • suspect- filters records that are suspected to be a match.

Response

Returns potential matches for the entity pairs with their shortest transitive paths, along with the maximum of relevance score value and the corresponding action label for every relevance-based match rule that identifies the entity pair as a match.

Consider the following examples:

  • the markMatchedValues parameter is set to its default value of false.

Example of default request

GET {TenantURL}/entities/00005KL/_transitiveMatches

Example of default response

[
    {
        "matchRules": [
            "configuration/entityTypes/ObjectWithNamesCleansing/matchGroups/SameNameMulti"
        ],
        "object": {
            "uri": "entities/1B2TT8ty",
            "type": "configuration/entityTypes/ObjectWithNamesCleansing",
            "createdBy": "xyz@reltio.com",
            "createdTime": 1651835570258,
            "updatedBy": "xyz@reltio.com",
            "updatedTime": 1651835570258,
            "attributes": {
                "Name1": [
                    {
                        "type": "configuration/entityTypes/ObjectWithNamesCleansing/attributes/Name1",
                        "ov": true,
                        "value": "Isadora",
                        "uri": "entities/1B2TT8ty/attributes/Name1/31qBYMgkw"
                    }
                ],
                "Name2": [
                    {
                        "type": "configuration/entityTypes/ObjectWithNamesCleansing/attributes/Name2",
                        "ov": true,
                        "value": "Duncan",
                        "uri": "entities/1B2TT8ty/attributes/Name2/31qBYMl1C"
                    }
                ]
            },
            "isFavorite": false,
            "crosswalks": [
                {
                    "uri": "entities/1B2TT8ty/crosswalks/31qBYMxny",
                    "type": "configuration/sources/Reltio",
                    "value": "1B2TT8ty",
                    "reltioLoadDate": "2022-05-06T11:12:50.258Z",
                    "createDate": "2022-05-06T11:12:50.258Z",
                    "updateDate": "2022-05-06T11:12:50.258Z",
                    "attributes": [
                        "entities/1B2TT8ty/attributes/Name1/31qBYMgkw",
                        "entities/1B2TT8ty/attributes/Name2/31qBYMl1C"
                    ],
                    "singleAttributeUpdateDates": {}
                }
            ],
            "analyticsAttributes": {},
            "label": "",
            "secondaryLabel": ""
        },
        "shortestTransitiveMatchPath": [
            {
                "matchRules": [
                    "configuration/entityTypes/ObjectWithNamesCleansing/matchGroups/SameNameMulti"
                ],
                "match": "entities/1B2TT8ty"
            }
        ],
        "direct": true,
    	"relevance": 0.5,
    	"label": "Good matches",
		"createdTime": 1709908613750,
    	"matchRuleSummaries": [
      		{
        		"uri": "configuration/entityTypes/HCP/matchGroups/SameNameMulti",
        		"relevance": 0.5,
        		"actionLabel": "Good matches",
				"createdTime": 1709908613750
      		}
				]
    },
    {
        "matchRules": [
            "configuration/entityTypes/ObjectWithNamesCleansing/matchGroups/SameNameMulti"
        ],
        "object": {
            "uri": "entities/1B2TTDAE",
            "type": "configuration/entityTypes/ObjectWithNamesCleansing",
            "createdBy": "xyz@reltio.com",
            "createdTime": 1651835570258,
            "updatedBy": "xyz@reltio.com",
            "updatedTime": 1651835570258,
            "attributes": {
                "Name1": [
                    {
                        "type": "configuration/entityTypes/ObjectWithNamesCleansing/attributes/Name1",
                        "ov": true,
                        "value": "Dora",
                        "uri": "entities/1B2TTDAE/attributes/Name1/31qBYMpHS"
                    }
                ],
                "Name2": [
                    {
                        "type": "configuration/entityTypes/ObjectWithNamesCleansing/attributes/Name2",
                        "ov": true,
                        "value": "Duncan",
                        "uri": "entities/1B2TTDAE/attributes/Name2/31qBYMtXi"
                    }
                ]
            },
            "isFavorite": false,
            "crosswalks": [
                {
                    "uri": "entities/1B2TTDAE/crosswalks/31qBYN24E",
                    "type": "configuration/sources/Reltio",
                    "value": "1B2TTDAE",
                    "reltioLoadDate": "2022-05-06T11:12:50.258Z",
                    "createDate": "2022-05-06T11:12:50.258Z",
                    "updateDate": "2022-05-06T11:12:50.258Z",
                    "attributes": [
                        "entities/1B2TTDAE/attributes/Name2/31qBYMtXi",
                        "entities/1B2TTDAE/attributes/Name1/31qBYMpHS"
                    ],
                    "singleAttributeUpdateDates": {}
                }
            ],
            "analyticsAttributes": {},
            "label": "",
            "secondaryLabel": ""
        },
        "shortestTransitiveMatchPath": [
            {
                "matchRules": [
                    "configuration/entityTypes/ObjectWithNamesCleansing/matchGroups/SameNameMulti"
                ],
                "match": "entities/1B2TTDAE"
            }
        ],
        "direct": true,
    	"relevance": 0.5,
    	"label": "Good matches",
		"createdTime": 1709908613750,
    	"matchRuleSummaries": [
      		{
        		"uri": "configuration/entityTypes/HCP/matchGroups/SameNameMulti",
        		"relevance": 0.5,
        		"actionLabel": "Good matches",
				"createdTime": 1709908613750
      		}
		]
    }
]

  • the markMatchedValues parameter is set to true.

Example of request with markMatchedValues

GET {TenantURL}/entities/00005KL/_transitiveMatches?markMatchedValues=true

Example of response with markMatchedValues

[
    {
        "matchRules": [
            "configuration/entityTypes/ObjectWithNamesCleansing/matchGroups/SameNameMulti"
        ],
        "matchedValues": {
            "configuration/entityTypes/ObjectWithNamesCleansing/matchGroups/SameNameMulti": [
                {
                    "value": {
                        "values": [
                            {
                                "uri": "entities/1B2TT8ty/attributes/Name1/31qBYMgkw"
                            },
                            {
                                "uri": "entities/1B2TT8ty/attributes/Name2/31qBYMl1C"
                            }
                        ]
                    },
                    "matches": [
                        {
                            "value": {
                                "values": [
                                    {
                                        "uri": "entities/2Q4yWUZ/attributes/Name1/FH4ucFuh"
                                    },
                                    {
                                        "uri": "entities/2Q4yWUZ/attributes/Name2/FH4ucKAx"
                                    }
                                ]
                            }
                        }
                    ]
                }
            ]
        },
        "object": {
            "uri": "entities/1B2TT8ty",
            "type": "configuration/entityTypes/ObjectWithNamesCleansing",
            "createdBy": "xyz@reltio.com",
            "createdTime": 1651835570258,
            "updatedBy": "xyz@reltio.com",
            "updatedTime": 1651835570258,
            "attributes": {
                "Name1": [
                    {
                        "type": "configuration/entityTypes/ObjectWithNamesCleansing/attributes/Name1",
                        "ov": true,
                        "value": "Isadora",
                        "uri": "entities/1B2TT8ty/attributes/Name1/31qBYMgkw"
                    }
                ],
                "Name2": [
                    {
                        "type": "configuration/entityTypes/ObjectWithNamesCleansing/attributes/Name2",
                        "ov": true,
                        "value": "Duncan",
                        "uri": "entities/1B2TT8ty/attributes/Name2/31qBYMl1C"
                    }
                ]
            },
            "isFavorite": false,
            "crosswalks": [
                {
                    "uri": "entities/1B2TT8ty/crosswalks/31qBYMxny",
                    "type": "configuration/sources/Reltio",
                    "value": "1B2TT8ty",
                    "reltioLoadDate": "2022-05-06T11:12:50.258Z",
                    "createDate": "2022-05-06T11:12:50.258Z",
                    "updateDate": "2022-05-06T11:12:50.258Z",
                    "attributes": [
                        "entities/1B2TT8ty/attributes/Name1/31qBYMgkw",
                        "entities/1B2TT8ty/attributes/Name2/31qBYMl1C"
                    ],
                    "singleAttributeUpdateDates": {}
                }
            ],
            "analyticsAttributes": {},
            "label": "",
            "secondaryLabel": ""
        },
        "shortestTransitiveMatchPath": [
            {
                "matchRules": [
                    "configuration/entityTypes/ObjectWithNamesCleansing/matchGroups/SameNameMulti"
                ],
                "match": "entities/1B2TT8ty"
            }
        ],
        "direct": true,
    	"relevance": 0.5,
    	"label": "Good matches",
		"createdTime": 1709908613750,
    	"matchRuleSummaries": [
      		{
        		"uri": "configuration/entityTypes/HCP/matchGroups/SameNameMulti",
        		"relevance": 0.5,
        		"actionLabel": "Good matches",
				"createdTime": 1709908613750
      		}
		]
    },
    {
        "matchRules": [
            "configuration/entityTypes/ObjectWithNamesCleansing/matchGroups/SameNameMulti"
        ],
        "matchedValues": {
            "configuration/entityTypes/ObjectWithNamesCleansing/matchGroups/SameNameMulti": [
                {
                    "value": {
                        "values": [
                            {
                                "uri": "entities/1B2TTDAE/attributes/Name1/31qBYMpHS"
                            },
                            {
                                "uri": "entities/1B2TTDAE/attributes/Name2/31qBYMtXi"
                            }
                        ]
                    },
                    "matches": [
                        {
                            "value": {
                                "values": [
                                    {
                                        "uri": "entities/2Q4yWUZ/attributes/Name1/FH4ucFuh"
                                    },
                                    {
                                        "uri": "entities/2Q4yWUZ/attributes/Name2/FH4ucKAx"
                                    }
                                ]
                            }
                        },
                        {
                            "value": {
                                "values": [
                                    {
                                        "uri": "entities/2Q4yWUZ/attributes/Name1/FH4ucFuh"
                                    },
                                    {
                                        "uri": "entities/2Q4yWUZ/attributes/Name2/FH4ucKAx"
                                    }
                                ]
                            }
                        },
                        {
                            "value": {
                                "values": [
                                    {
                                        "uri": "entities/2Q4yWUZ/attributes/Name1/FH4ucFuh"
                                    },
                                    {
                                        "uri": "entities/2Q4yWUZ/attributes/Name2/FH4ucKAx"
                                    }
                                ]
                            }
                        },
                        {
                            "value": {
                                "values": [
                                    {
                                        "uri": "entities/2Q4yWUZ/attributes/Name1/FH4ucFuh"
                                    },
                                    {
                                        "uri": "entities/2Q4yWUZ/attributes/Name2/FH4ucKAx"
                                    }
                                ]
                            }
                        }
                    ]
                }
            ]
        },
        "object": {
            "uri": "entities/1B2TTDAE",
            "type": "configuration/entityTypes/ObjectWithNamesCleansing",
            "createdBy": "xyz@reltio.com",
            "createdTime": 1651835570258,
            "updatedBy": "xyz@reltio.com",
            "updatedTime": 1651835570258,
            "attributes": {
                "Name1": [
                    {
                        "type": "configuration/entityTypes/ObjectWithNamesCleansing/attributes/Name1",
                        "ov": true,
                        "value": "Dora",
                        "uri": "entities/1B2TTDAE/attributes/Name1/31qBYMpHS"
                    }
                ],
                "Name2": [
                    {
                        "type": "configuration/entityTypes/ObjectWithNamesCleansing/attributes/Name2",
                        "ov": true,
                        "value": "Duncan",
                        "uri": "entities/1B2TTDAE/attributes/Name2/31qBYMtXi"
                    }
                ]
            },
            "isFavorite": false,
            "crosswalks": [
                {
                    "uri": "entities/1B2TTDAE/crosswalks/31qBYN24E",
                    "type": "configuration/sources/Reltio",
                    "value": "1B2TTDAE",
                    "reltioLoadDate": "2022-05-06T11:12:50.258Z",
                    "createDate": "2022-05-06T11:12:50.258Z",
                    "updateDate": "2022-05-06T11:12:50.258Z",
                    "attributes": [
                        "entities/1B2TTDAE/attributes/Name2/31qBYMtXi",
                        "entities/1B2TTDAE/attributes/Name1/31qBYMpHS"
                    ],
                    "singleAttributeUpdateDates": {}
                }
            ],
            "analyticsAttributes": {},
            "label": "",
            "secondaryLabel": ""
        },
        "shortestTransitiveMatchPath": [
            {
                "matchRules": [
                    "configuration/entityTypes/ObjectWithNamesCleansing/matchGroups/SameNameMulti"
                ],
                "match": "entities/1B2TTDAE"
            }
        ],
        "direct": true,
    	"relevance": 0.5,
    	"label": "Good matches",
		"createdTime": 1709908613750,
    	"matchRuleSummaries": [
      		{
        		"uri": "configuration/entityTypes/HCP/matchGroups/SameNameMulti",
        		"relevance": 0.5,
        		"actionLabel": "Good matches",
				"createdTime": 1709908613750
      		}
		]
    }
]

Updated on December 9, 2024

Footer

You've found your way to a temporary environment. Content is not complete or final. Looking for Reltio documentation? Go to docs.reltio.com.

Company

Leadership

Careers

Awards

Contact Us

Reltio Newsroom

Press Releases

Media Coverage

Media & Analyst Resources

Customer Support

Support

Reltio Learn

Community

Developer Portal

100 Marine Parkway, Suite 275

Redwood Shores, CA 94065

USA

North America: +1(855)360-3282

Europe: +44(800)368-7643

Email: sales@reltio.com

© 2024 The RELTIO® mark is a registered trademark of Reltio, Inc. in the United States and other countries; DataDriven and Reltio Data Cloud are trademarks of Reltio, Inc. Other names or marks are trademarks of their respective owners.

Terms, Privacy Policy, and