Skip to main content Skip to complementary content
Close announcements banner

Return a matching explanation about input records

Returns a detailed explanation about how input data records for an entity with a match rule attached can be matched and grouped. The data records are provided in the request content as XML fragments.
Request
POST /services/rest/tasks/matching/explain
Parameters
  • model: This is a String value which represents the name of the MDM data model.
  • type: This is a String value which specifies the name of the entity.
Headers
  • Content-Type: application/xml
    Information noteNote: If the XML declaration is included in the XML request content and the encoding attribute is used, you must set its value to UTF-8.
  • Accept: application/json
  • Authorization: Basic Authentication scheme
Response A JSON response that gives a detailed explanation about how the input data records for the specified entity with a match rule attached can be matched and grouped.
Status
  • 200 OK: The operation is executed successfully.
  • 401 UNAUTHORIZED: Login fails, invalid username or password.
  • 500 INTERNAL SERVER ERROR: Other errors.

Sample request

<Store>
	<Id>200001</Id>
	<Address>Beijing Book Building (17 Xichang'an Jie)</Address>
	<Lat>116.383681</Lat>
	<Long>39.913855</Long>
</Store>
<Store>
	<Id>200002</Id>
	<Address>Beijing book building</Address>
	<Lat>116.383680</Lat>
	<Long>39.913856</Long>
</Store>

Sample response

{
  "groups": [
    {
      "group": [
        {
          "result": [
            {
              "id": "4244168a-acd7-42a0-91b7-873422c4982b"
            },
            {
              "confidence": 0.9157568693161011
            },
            {
              "minimum_confidences": [
                {
                  "minimum_confidence": 0.85
                }
              ]
            },
            {
              "match_confidences": [
                {
                  "match_confidence": 0.9
                }
              ]
            },
            {
              "related_ids": [
                "200002",
                "200001"
              ]
            },
            {
              "values": [
                {
                  "value": [
                    {
                      "field": "Store/Id"
                    },
                    {
                      "value": "200001"
                    }
                  ]
                },
                {
                  "value": [
                    {
                      "field": "Store/Address"
                    },
                    {
                      "value": "Beijing Book Building (17 Xichang'an Jie)"
                    }
                  ]
                },
                {
                  "value": [
                    {
                      "field": "Store/Lat"
                    },
                    {
                      "value": "116.383681"
                    }
                  ]
                },
                {
                  "value": [
                    {
                      "field": "Store/Long"
                    },
                    {
                      "value": "39.913856"
                    }
                  ]
                },
                {
                  "value": [
                    {
                      "field": "Store/Map"
                    },
                    {
                      "value": ""
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "details": [
            {
              "detail": [
                {
                  "id": "200002"
                },
                {
                  "match": [
                    {
                      "is_match": true
                    },
                    {
                      "score": 0.9157568693161011
                    },
                    {
                      "field_scores": [
                        {
                          "field_score": [
                            {
                              "pair_id": "200001"
                            },
                            {
                              "field": "Store/Id"
                            },
                            {
                              "fieldValue": "200002"
                            },
                            {
                              "value": 1
                            },
                            {
                              "algorithm": "Placeholder"
                            },
                            {
                              "threshold": 0
                            }
                          ]
                        },
                        {
                          "field_score": [
                            {
                              "pair_id": "200001"
                            },
                            {
                              "field": "Store/Address"
                            },
                            {
                              "fieldValue": "Beijing book building"
                            },
                            {
                              "value": 0.9157568693161011
                            },
                            {
                              "algorithm": "Jaro-Winkler"
                            },
                            {
                              "threshold": 0.9
                            }
                          ]
                        },
                        {
                          "field_score": [
                            {
                              "pair_id": "200001"
                            },
                            {
                              "field": "Store/Lat"
                            },
                            {
                              "fieldValue": "116.38368"
                            },
                            {
                              "value": 1
                            },
                            {
                              "algorithm": "Placeholder"
                            },
                            {
                              "threshold": 0
                            }
                          ]
                        },
                        {
                          "field_score": [
                            {
                              "pair_id": "200001"
                            },
                            {
                              "field": "Store/Long"
                            },
                            {
                              "fieldValue": "39.913856"
                            },
                            {
                              "value": 1
                            },
                            {
                              "algorithm": "Plaeholder"
                            },
                            {
                              "threshold": 0
                            }
                          ]
                        },
                        {
                          "field_score": [
                            {
                              "pair_id": "200001"
                            },
                            {
                              "field": "Store/Map"
                            },
                            {
                              "fieldValue": ""
                            },
                            {
                              "value": 1
                            },
                            {
                              "algorithm": "Placeholder"
                            },
                            {
                              "threshold": 0
                            }
                          ]
                        }
                      ]
                    }
                  ]
                },
                {
                  "values": [
                    {
                      "value": [
                        {
                          "field": "Store/Long"
                        },
                        {
                          "value": "39.913856"
                        }
                      ]
                    },
                    {
                      "value": [
                        {
                          "field": "Store/Map"
                        },
                        {
                          "value": ""
                        }
                      ]
                    },
                    {
                      "value": [
                        {
                          "field": "Store/Address"
                        },
                        {
                          "value": "Beijing book building"
                        }
                      ]
                    },
                    {
                      "value": [
                        {
                          "field": "Store/Id"
                        },
                        {
                          "value": "200002"
                        }
                      ]
                    },
                    {
                      "value": [
                        {
                          "field": "Store/Lat"
                        },
                        {
                          "value": "116.38368"
                        }
                      ]
                    }
                  ]
                }
              ]
            },
            {
              "detail": [
                {
                  "id": "200001"
                },
                {
                  "match": [
                    {
                      "is_match": true
                    },
                    {
                      "score": 0.9157568693161011
                    },
                    {
                      "field_scores": [
                        {
                          "field_score": [
                            {
                              "pair_id": "200002"
                            },
                            {
                              "field": "Store/Id"
                            },
                            {
                              "fieldValue": "200002"
                            },
                            {
                              "value": 1
                            },
                            {
                              "algorithm": "Placeholder"
                            },
                            {
                              "threshold": 0
                            }
                          ]
                        },
                        {
                          "field_score": [
                            {
                              "pair_id": "200002"
                            },
                            {
                              "field": "Store/Address"
                            },
                            {
                              "fieldValue": "Beijing book building"
                            },
                            {
                              "value": 0.9157568693161011
                            },
                            {
                              "algorithm": "Jaro-Winkler"
                            },
                            {
                              "threshold": 0.9
                            }
                          ]
                        },
                        {
                          "field_score": [
                            {
                              "pair_id": "200002"
                            },
                            {
                              "field": "Store/Lat"
                            },
                            {
                              "fieldValue": "116.38368"
                            },
                            {
                              "value": 1
                            },
                            {
                              "algorithm": "Placeholder"
                            },
                            {
                              "threshold": 0
                            }
                          ]
                        },
                        {
                          "field_score": [
                            {
                              "pair_id": "200002"
                            },
                            {
                              "field": "Store/Long"
                            },
                            {
                              "fieldValue": "39.913856"
                            },
                            {
                              "value": 1
                            },
                            {
                              "algorithm": "Placeholder"
                            },
                            {
                              "threshold": 0
                            }
                          ]
                        },
                        {
                          "field_score": [
                            {
                              "pair_id": "200002"
                            },
                            {
                              "field": "Store/Map"
                            },
                            {
                              "fieldValue": ""
                            },
                            {
                              "value": 1
                            },
                            {
                              "algorithm": "Placeholder"
                            },
                            {
                              "threshold": 0
                            }
                          ]
                        }
                      ]
                    }
                  ]
                },
                {
                  "values": [
                    {
                      "value": [
                        {
                          "field": "Store/Long"
                        },
                        {
                          "value": "39.913855"
                        }
                      ]
                    },
                    {
                      "value": [
                        {
                          "field": "Store/Map"
                        },
                        {
                          "value": ""
                        }
                      ]
                    },
                    {
                      "value": [
                        {
                          "field": "Store/Address"
                        },
                        {
                          "value": "Beijing Book Building (17 Xichang'an Jie)"
                        }
                      ]
                    },
                    {
                      "value": [
                        {
                          "field": "Store/Id"
                        },
                        {
                          "value": "200001"
                        }
                      ]
                    },
                    {
                      "value": [
                        {
                          "field": "Store/Lat"
                        },
                        {
                          "value": "116.383681"
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!