Get Matches With Scoring

This operation returns potential matches with scoring based on rules in the entity type configuration.

Request:

POST https://{TenantURL}/{TenantID}/entities/_scoredmatches
Table 1. Parameters
Name Type Required Notes
Entity Types String Yes

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

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

select String No

Comma-separated list of properties from the entity structure that must be returned in a response. Allows you to return a partial entity object."

Example: select=uri,label,attributes,crosswalks from the referenced object

To ensure improved performance of _scoredMatches, properly define the properties list in the select parameter. The possible variants are:

  • 'uri' and/or 'type' (select=uri,type). No objects are loaded. The most efficient and recommended way.
  • Simple or nested attributes from the object are specified. A lightweight operation is performed to retrieve the object without references.
  • no 'select'; 'select=attributes', contains some reference attributes that are loaded with the object.

The above mentioned optimizations work only if there is no configured data security for the entity type, else the object is loaded fully. If there are a a large number of matches for input entities, then the response size can be very large. The size is limited to 100 MB. In such a case, it is recommended to reduce the number of input entities and decrease the value of the 'max' parameter.

If the Request has the select parameter, there must not be any space between the query parameters.

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

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

Available options:

  • sendHidden-disabled by default, 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. If you have a nested or reference attribute value where ov=true, but sub-attributes where ov=false, then these sub-attributes will not appear in the response.
offset Integer No Can be used to organize pagination in the response. The default is 0.

Request Body

{  
   "type":"configuration/entityTypes/Product",
   "attributes":{  
      "Name":[  
         {  
            "value":"Real Appeal"
         }
      ]
   }
}
}

Response:

If select = "uri,type", the response is as follows:

[
 {
   "index": 0,
   "object": [
     {
       "URI": "entities/KbAnVVZ",
       "type": "configuration/entityTypes/Product",
       "matchGroups": [
         {
           "uri": "configuration/entityTypes/Product/matchGroups/ExactName",
           "label": "By exact name",
           "type": "suspect",
           "scope": "ALL",
           "useOvOnly": "false",
           "crossTypeMatch": true,
           "scoreStandalone": 10,
           "scoreIncremental": 20
         }
       ],
       "matchScore": 0
     },
     {
       "URI": "entities/E5TAW30",
       "type": "configuration/entityTypes/Product",
       "matchGroups": [
         {
           "uri": "configuration/entityTypes/Product/matchGroups/ExactName",
           "label": "By exact name",
           "type": "suspect",
           "scope": "ALL",
           "useOvOnly": "false",
           "crossTypeMatch": true,
           "scoreStandalone": 10,
           "scoreIncremental": 20
         }
       ],
       "matchScore": 0
     },
     {
       "URI": "entities/E5NOtwY",
       "type": "configuration/entityTypes/Product",
       "matchGroups": [
         {
           "uri": "configuration/entityTypes/Product/matchGroups/ExactName",
           "label": "By exact name",
           "type": "suspect",
           "scope": "ALL",
           "useOvOnly": "false",
           "crossTypeMatch": true,
           "scoreStandalone": 10,
           "scoreIncremental": 20
         }
       ],
       "matchScore": 0
     }
   ],
   "successful": true
 }
]
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