Verify automatic unmerge
Learn how to search for potential contributors that you need to have unmerged in a JSON entity array in your tenant.
Use the _verifyUnmerge to search a JSON entity array in your tenant for contributors that you might need to have unmerged. This API tests the contributors of a consolidated profile against the automatic match rules. Whether you have Automatic Unmerge enabled at the entity type level or not, you get information on which:
- contributing profile(s) should be unmerged from that consolidated profile
- match rule(s) cause that/those contributing profile(s) to no longer match
Request
POST {ApplicationURL}/reltio/api/{tenantId}/entities/_verifyUnmerge| Parameter | Required | Default Value | Description | |
|---|---|---|---|---|
| Path | tenantId | Yes | Unique identification number for this tenant. | |
| Body | entityUri | Yes | URI for the entity you want to test. | |
| contributors | No | Contributor URI/ID. Checks solely a specified contributor. | ||
| matchGroups | No | Checks custom match groups in your consolidated profile. | ||
| rules | No | all | Match Rules' URIs considered for the test. | |
| show | No | brief | Determines the information returned in the response:
| |
| time | No | <current time> | Point in time for which the unmerge explanation is required. Allows you to request unmerge details as they were at a specific historical moment. In Unix time, for example |
Request
Return the results of contributors' tests for the entity defined in the body.
Example
POST {TenantURL}/entities/_verifyUnmerge
Body:
{
"entityUri": "entities/00009qz",
"show": "full",
"time": 1699390308900
}
Response
{
"unmerge": true,
"first": {
"uri": "entities/00NTZCt",
"type": "configuration/entityTypes/HCP",
"createdBy": "test.user@reltio.com",
"createdTime": 1699290084239,
"updatedBy": "test.user@reltio.com",
"updatedTime": 1699290308900,
"attributes": {
"FirstName": [
{
"type": "configuration/entityTypes/HCP/attributes/FirstName",
"ov": true,
"value": "TestFirstName",
"uri": "entities/00NTZCt/attributes/FirstName/2vIVUDD"
}
],
"LastName": [
{
"type": "configuration/entityTypes/HCP/attributes/LastName",
"ov": true,
"value": "TestLastName",
"uri": "entities/00NTZCt/attributes/LastName/2vIVYTT"
}
],
"MiddleName": [
{
"type": "configuration/entityTypes/HCP/attributes/MiddleName",
"ov": true,
"value": "TestMiddleName",
"uri": "entities/00NTZCt/attributes/MiddleName/2vIVcjj"
}
],
"License": [
{
"label": "300001, state",
"value": {
"Category": [
{
"type": "configuration/entityTypes/HCP/attributes/License/attributes/Category",
"ov": true,
"value": "Health",
"uri": "entities/00NTZCt/attributes/License/2vIVHQR/Category/2vIVPwx"
}
],
"Number": [
{
"type": "configuration/entityTypes/HCP/attributes/License/attributes/Number",
"ov": true,
"value": "300001",
"uri": "entities/00NTZCt/attributes/License/2vIVHQR/Number/2vIVLgh"
}
]
},
"ov": true,
"uri": "entities/00NTZCt/attributes/License/2vIVHQR"
}
]
},
"isFavorite": false,
"crosswalks": [
{
"uri": "entities/00NTZCt/crosswalks/2vIVgzz",
"type": "configuration/sources/FB",
"value": "FBBB-555",
"reltioLoadDate": "2023-11-06T17:01:24.239Z",
"createDate": "2023-11-06T17:01:24.239Z",
"updateDate": "2023-11-06T17:01:24.239Z",
"attributes": [
"entities/00NTZCt/attributes/License/2vIVHQR/Category/2vIVPwx",
"entities/00NTZCt/attributes/MiddleName/2vIVcjj",
"entities/00NTZCt/attributes/FirstName/2vIVUDD",
"entities/00NTZCt/attributes/LastName/2vIVYTT",
"entities/00NTZCt/attributes/License/2vIVHQR",
"entities/00NTZCt/attributes/License/2vIVHQR/Number/2vIVLgh"
],
"singleAttributeUpdateDates": {}
}
],
"analyticsAttributes": {},
"label": "TestFirstName TestMiddleName TestLastName, ()",
"secondaryLabel": ""
},
"second": {
"uri": "entities/00NTUwd",
"type": "configuration/entityTypes/HCP",
"createdBy": "johnny.data.steward@.mycompany.com",
"createdTime": 1699290084239,
"updatedBy": "johnny.data.steward@.mycompany.com",
"updatedTime": 1699290308900,
"attributes": {
"FirstName": [
{
"type": "configuration/entityTypes/HCP/attributes/FirstName",
"ov": true,
"value": "TestFirstName",
"uri": "entities/00NTUwd/attributes/FirstName/2vIVUDD"
}
],
"LastName": [
{
"type": "configuration/entityTypes/HCP/attributes/LastName",
"ov": true,
"value": "TestLastName",
"uri": "entities/00NTUwd/attributes/LastName/2vIVYTT"
}
],
"MiddleName": [
{
"type": "configuration/entityTypes/HCP/attributes/MiddleName",
"ov": true,
"value": "TestMiddleName",
"uri": "entities/00NTUwd/attributes/MiddleName/20q012"
}
],
"License": [
{
"label": "Changed300001, state",
"value": {
"Category": [
{
"type": "configuration/entityTypes/HCP/attributes/License/attributes/Category",
"ov": true,
"value": "Health",
"uri": "entities/00NTUwd/attributes/License/20pnEG/Category/20prUW"
}
],
"Number": [
{
"type": "configuration/entityTypes/HCP/attributes/License/attributes/Number",
"ov": true,
"value": "Changed300001",
"uri": "entities/00NTUwd/attributes/License/20pnEG/Number/20pvkm"
}
]
},
"ov": true,
"uri": "entities/00NTUwd/attributes/License/20pnEG"
}
]
},
"isFavorite": false,
"crosswalks": [
{
"uri": "entities/00NTZCt/crosswalks/2vIVDAB",
"type": "configuration/sources/FB",
"value": "FBBB-444",
"reltioLoadDate": "2023-11-06T17:01:24.239Z",
"createDate": "2023-11-06T17:01:24.239Z",
"updateDate": "2023-11-06T17:01:24.239Z",
"attributes": [
"entities/00NTUwd/attributes/FirstName/2vIVUDD",
"entities/00NTUwd/attributes/MiddleName/20q012",
"entities/00NTUwd/attributes/License/20pnEG",
"entities/00NTUwd/attributes/LastName/2vIVYTT",
"entities/00NTUwd/attributes/License/20pnEG/Category/20prUW",
"entities/00NTUwd/attributes/License/20pnEG/Number/20pvkm"
],
"singleAttributeUpdateDates": {
"entities/00NTUwd/attributes/License/20pnEG": "2023-11-06T17:05:08.900Z",
"entities/00NTUwd/attributes/License/20pnEG/Number/20pvkm": "2023-11-06T17:05:08.900Z"
}
}
],
"analyticsAttributes": {},
"label": "TestFirstName TestMiddleName TestLastName, ()",
"secondaryLabel": ""
},
"contributors": [
"entities/00NTUwd"
],
"details": {
"messages": [
"Unmerge is not enabled for EntityType: HCP. Unmerge outcome is populated anyway"
],
"contributors": [
{
"uri": "entities/00NTUwd",
"unmerge": true,
"originProfile": {
"uri": "entities/00NTZCt",
"type": "configuration/entityTypes/HCP",
"createdBy": "johnny.data.steward@.mycompany.com",
"createdTime": 1699290084239,
"updatedBy": "johnny.data.steward@.mycompany.com",
"updatedTime": 1699290308900,
"attributes": {
"FirstName": [
{
"type": "configuration/entityTypes/HCP/attributes/FirstName",
"ov": true,
"value": "TestFirstName",
"uri": "entities/00NTZCt/attributes/FirstName/2vIVUDD"
}
],
"LastName": [
{
"type": "configuration/entityTypes/HCP/attributes/LastName",
"ov": true,
"value": "TestLastName",
"uri": "entities/00NTZCt/attributes/LastName/2vIVYTT"
}
],
"MiddleName": [
{
"type": "configuration/entityTypes/HCP/attributes/MiddleName",
"ov": true,
"value": "TestMiddleName",
"uri": "entities/00NTZCt/attributes/MiddleName/2vIVcjj"
}
],
"License": [
{
"label": "300001, state",
"value": {
"Category": [
{
"type": "configuration/entityTypes/HCP/attributes/License/attributes/Category",
"ov": true,
"value": "Health",
"uri": "entities/00NTZCt/attributes/License/2vIVHQR/Category/2vIVPwx"
}
],
"Number": [
{
"type": "configuration/entityTypes/HCP/attributes/License/attributes/Number",
"ov": true,
"value": "300001",
"uri": "entities/00NTZCt/attributes/License/2vIVHQR/Number/2vIVLgh"
}
]
},
"ov": true,
"uri": "entities/00NTZCt/attributes/License/2vIVHQR"
}
]
},
"isFavorite": false,
"crosswalks": [
{
"uri": "entities/00NTZCt/crosswalks/2vIVgzz",
"type": "configuration/sources/FB",
"value": "FBBB-555",
"reltioLoadDate": "2023-11-06T17:01:24.239Z",
"createDate": "2023-11-06T17:01:24.239Z",
"updateDate": "2023-11-06T17:01:24.239Z",
"attributes": [
"entities/00NTZCt/attributes/License/2vIVHQR/Category/2vIVPwx",
"entities/00NTZCt/attributes/MiddleName/2vIVcjj",
"entities/00NTZCt/attributes/FirstName/2vIVUDD",
"entities/00NTZCt/attributes/LastName/2vIVYTT",
"entities/00NTZCt/attributes/License/2vIVHQR",
"entities/00NTZCt/attributes/License/2vIVHQR/Number/2vIVLgh"
],
"singleAttributeUpdateDates": {}
}
],
"analyticsAttributes": {},
"label": "TestFirstName TestMiddleName TestLastName, ()",
"secondaryLabel": ""
},
"originMatchDocument": {
"FirstName": [
"testfirstname"
],
"~@i": "00NTZCt",
"License": [
{
"Number~.@ps": [
"10"
],
"Number": [
"300001"
]
}
],
"LastName~.@ps": [
"10"
],
"$$_entity_type_$$": [
"HCP"
],
"LastName": [
"testlastname"
],
"FirstName~.@ps": [
"10"
],
"$$_entity_type_$$~.@ps": [
"10"
],
"License~.@ps": [
"10"
]
},
"unmergeProfile": {
"uri": "entities/00NTUwd",
"type": "configuration/entityTypes/HCP",
"createdBy": "johnny.data.steward@.mycompany.com",
"createdTime": 1699290084239,
"updatedBy": "johnny.data.steward@.mycompany.com",
"updatedTime": 1699290308900,
"attributes": {
"FirstName": [
{
"type": "configuration/entityTypes/HCP/attributes/FirstName",
"ov": true,
"value": "TestFirstName",
"uri": "entities/00NTUwd/attributes/FirstName/2vIVUDD"
}
],
"LastName": [
{
"type": "configuration/entityTypes/HCP/attributes/LastName",
"ov": true,
"value": "TestLastName",
"uri": "entities/00NTUwd/attributes/LastName/2vIVYTT"
}
],
"MiddleName": [
{
"type": "configuration/entityTypes/HCP/attributes/MiddleName",
"ov": true,
"value": "TestMiddleName",
"uri": "entities/00NTUwd/attributes/MiddleName/20q012"
}
],
"License": [
{
"label": "Changed300001, state",
"value": {
"Category": [
{
"type": "configuration/entityTypes/HCP/attributes/License/attributes/Category",
"ov": true,
"value": "Health",
"uri": "entities/00NTUwd/attributes/License/20pnEG/Category/20prUW"
}
],
"Number": [
{
"type": "configuration/entityTypes/HCP/attributes/License/attributes/Number",
"ov": true,
"value": "Changed300001",
"uri": "entities/00NTUwd/attributes/License/20pnEG/Number/20pvkm"
}
]
},
"ov": true,
"uri": "entities/00NTUwd/attributes/License/20pnEG"
}
]
},
"isFavorite": false,
"crosswalks": [
{
"uri": "entities/00NTZCt/crosswalks/2vIVDAB",
"type": "configuration/sources/FB",
"value": "FBBB-444",
"reltioLoadDate": "2023-11-06T17:01:24.239Z",
"createDate": "2023-11-06T17:01:24.239Z",
"updateDate": "2023-11-06T17:01:24.239Z",
"attributes": [
"entities/00NTUwd/attributes/FirstName/2vIVUDD",
"entities/00NTUwd/attributes/MiddleName/20q012",
"entities/00NTUwd/attributes/License/20pnEG",
"entities/00NTUwd/attributes/LastName/2vIVYTT",
"entities/00NTUwd/attributes/License/20pnEG/Category/20prUW",
"entities/00NTUwd/attributes/License/20pnEG/Number/20pvkm"
],
"singleAttributeUpdateDates": {
"entities/00NTUwd/attributes/License/20pnEG": "2023-11-06T17:05:08.900Z",
"entities/00NTUwd/attributes/License/20pnEG/Number/20pvkm": "2023-11-06T17:05:08.900Z"
}
}
],
"analyticsAttributes": {},
"label": "TestFirstName TestMiddleName TestLastName, ()",
"secondaryLabel": ""
},
"unmergeMatchDocument": {
"FirstName": [
"testfirstname"
],
"~@i": "00NTUwd",
"License": [
{
"Number~.@ps": [
"10"
],
"Number": [
"changed300001"
]
}
],
"LastName~.@ps": [
"10"
],
"$$_entity_type_$$": [
"HCP"
],
"LastName": [
"testlastname"
],
"FirstName~.@ps": [
"10"
],
"$$_entity_type_$$~.@ps": [
"10"
],
"License~.@ps": [
"10"
]
}
}
],
"rulesApplicable": [
{
"uri": "configuration/entityTypes/HCP/matchGroups/Rule3"
}
]
}
}
This table describes the fields in the response
| Field | Description |
|---|---|
unmerge | Value =true if the entities should be unmerged. |
first and second | Entities that should be unmerged. |
contributors | List of tested contributors. |
details | Displayed if show=full. |
.messages | Displays context information about the automatic unmerge verification. For example: "Entity has no contributors that should be unmerged", "Unmerge is not enabled for this Entity Type. Unmerge outcome is populated anyway", and "All contributors still match". |
.contributors | Displays detailed information on the tested contributors: uri, unmerge, originProfile, originMatchDocument, unmergeProfile, unmergeMatchDocument and matchGroups. |
contributors.unmerge | Indicates if a contributor profile should be unmerged =true or should be kept as is =false. |
contributors.originProfile | Displays complete contributors profiles. |
contributors.originMatchDocument | Match document's of the origin contributors' profiles. |
contributors.unmergeProfile | Displays the complete contributor's profile for the instances of profiles that should be unmerged . |
contributors.unmergeMatchDocument | Match document of the contributors' profiles for the instances of profiles that should be unmerged . |
contributors.matchGroups | List of Match Groups that validate the merge (empty if unmerge=true). |
rulesApplicable | List of checked Match rules. |