Get matches

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

Name Description
Input Payload List of entity objects to match (List <Map<String, Object>>)
Output Payload List of matched entity objects (List<Map<String, Object>>)
Data Sense

Dynamically Input/Output structures at design time

Map request object list to JSON, response JSON to object list

Command POST https://sndbx.reltio.com/reltio/api/pdxkfQZEfYhHTup/entities/_matches

Sample entities

[
{
    "type": "configuration/entityTypes/Individual",
    "attributes": {
      "FirstName": [
        {
          "value": "Johann"
        }
      ],
      "LastName": [
        {
          "value": "Smith"
        }
      ]
    }
  },
  {
    "type": "configuration/entityTypes/Individual",
    "attributes": {
      "FirstName": [
        {
          "value": "Megan"
        }
      ],
      "LastName": [
        {
          "value": "Fox"
        }
      ]
    }
  }
]

Sample response

[
    {
        "index": 0,
        "relevance": {
            "configuration/entityTypes/Individual/matchGroups/SameLastName": {
                "entities/O6FqPVZ": 1.0,
                "entities/O6FqLFJ": 1.0
            }
        },
        "object": {
            "configuration/entityTypes/Individual/matchGroups/SameLastName": [
                {
                    "uri": "entities/O6FqPVZ",
                    "type": "configuration/entityTypes/Individual",
                    "createdBy": "xyz@reltio.com",
                    "createdTime": 1659000603353,
                    "updatedBy": "xyz@reltio.com",
                    "updatedTime": 1659000603353,
                    "attributes": {
                        "FirstName": [
                            {
                                "type": "configuration/entityTypes/Individual/attributes/FirstName",
                                "ov": true,
                                "value": "Jack",
                                "uri": "entities/O6FqPVZ/attributes/FirstName/211NOwmPx"
                            }
                        ],
                        "LastName": [
                            {
                                "type": "configuration/entityTypes/Individual/attributes/LastName",
                                "ov": true,
                                "value": "Smith",
                                "uri": "entities/O6FqPVZ/attributes/LastName/211NOwqgD"
                            }
                        ]
                    },
                    "isFavorite": false,
                    "crosswalks": [
                        {
                            "uri": "entities/O6FqPVZ/crosswalks/211NOwuwT",
                            "type": "configuration/sources/Reltio",
                            "value": "O6FqPVZ",
                            "reltioLoadDate": "2022-07-28T09:30:03.353Z",
                            "createDate": "2022-07-28T09:30:03.353Z",
                            "updateDate": "2022-07-28T09:30:03.353Z",
                            "attributes": [
                                "entities/O6FqPVZ/attributes/FirstName/211NOwmPx",
                                "entities/O6FqPVZ/attributes/LastName/211NOwqgD"
                            ],
                            "singleAttributeUpdateDates": {}
                        }
                    ],
                    "analyticsAttributes": {},
                    "label": "",
                    "secondaryLabel": ""
                },
                {
                    "uri": "entities/O6FqLFJ",
                    "type": "configuration/entityTypes/Individual",
                    "createdBy": "xyz@reltio.com",
                    "createdTime": 1659000587317,
                    "updatedBy": "xyz@reltio.com",
                    "updatedTime": 1659000587317,
                    "attributes": {
                        "FirstName": [
                            {
                                "type": "configuration/entityTypes/Individual/attributes/FirstName",
                                "ov": true,
                                "value": "John",
                                "uri": "entities/O6FqLFJ/attributes/FirstName/211NOwZdB"
                            }
                        ],
                        "LastName": [
                            {
                                "type": "configuration/entityTypes/Individual/attributes/LastName",
                                "ov": true,
                                "value": "Smith",
                                "uri": "entities/O6FqLFJ/attributes/LastName/211NOwdtR"
                            }
                        ]
                    },
                    "isFavorite": false,
                    "crosswalks": [
                        {
                            "uri": "entities/O6FqLFJ/crosswalks/211NOwi9h",
                            "type": "configuration/sources/Reltio",
                            "value": "O6FqLFJ",
                            "reltioLoadDate": "2022-07-28T09:29:47.317Z",
                            "createDate": "2022-07-28T09:29:47.317Z",
                            "updateDate": "2022-07-28T09:29:47.317Z",
                            "attributes": [
                                "entities/O6FqLFJ/attributes/FirstName/211NOwZdB",
                                "entities/O6FqLFJ/attributes/LastName/211NOwdtR"
                            ],
                            "singleAttributeUpdateDates": {}
                        }
                    ],
                    "analyticsAttributes": {},
                    "label": "",
                    "secondaryLabel": ""
                }
            ]
        },
        "successful": true
    },
    {
        "index": 1,
        "relevance": {},
        "object": {},
        "successful": true
    }
]
Table 1. Parameters
Name Type Required Notes
EntityTypes String Yes

Dynamically populated by Connector Data Sense with list of Entity Types (Company / Individual / Product /...)

Once selected, connector with fetch / update Inbound and Outbound metadata to match specific Entity type

max Integer No Defines the maximum number of returned matches.
rules String No Defines match rule URIs to use in the matching-parameter. This parameter can be used in the request several times and each time parameter must specify one match rule URI, like:
rules=configuration/entityTypes/Individual/matchGroups/
      matchGroup1&rules=configuration/entityTypes/Individual/matchGroups/matchGroup2
options List No

Comma-separated list of different options that affect the entity's JSON content in the response.

Available options:

  • sendHidden-disabled by default, the entity's JSON will contain hidden attributes if this option is enabled.
  • ovOnly-return only attribute values that have ov=true flag.
  • nonOvOnly-return only attribute values that have ov=false flag. Subattributes won’t appear in the response if you have a nested or reference attribute value, where ov=true but a subattribute has ov=false.
activeness String No When it’s set to active, only active entities are listed in the response for the potential matches. Otherwise, all entities are listed as potential matches.