Merging Two Entities
Learn more about merging two entities.
This API selects one entity as the resulting "survivor" and combines all attributes, crosswalks, roles, and tags from the "losing" entity into "survivor". After the merge, the resulting entity can be accessed by both URIs through the API. In the ENTITIES_MERGED event, the URIs of the entities appear in the following order: the "winner" entity URI goes first, the "loser" entity URI goes next.
Impact of Entity Merging on Materialized Hierarchy
When entities in the same or different materialized hierarchies are merged, the merge can affect their hierarchy placement, connections, metadata, and effective dates. For information about the outcome of each scenario, see Effects of entity operations on materialized hierarchies.
Request
POST {TenantURL}/entities/12345/_sameAs?uri=entities/456789
Headers:
Authorization: Bearer {your-access-token}| Parameter | Required | Details | |
|---|---|---|---|
| Headers | Authorization
| Yes | Information about authentication access token in format "Bearer <accessToken>" (see details in Authentication API). |
| Query | URI
| Yes | URI of entity to merge entity specified in URL with. |
explicitWinner
| No | URI of an entity which should be "survivor". This URI should be one of entityURI1 or entityURI2; other values will be ignored. | |
Response
Returns a combined entity.
Request
POST {TenantURL}/entities/12345/_sameAs?URI=entities/456789
Headers: Authorization: Bearer {your-access-token}Response
{
"index": 0,
"object": {
"URI": "entities/12345",
"type": "configuration/entityTypes/Individual",
"createdBy": "User",
"createdTime": 1358768317681,
"updatedTime": 1358768317681,
"attributes": {
"LastName": [
{
"type": "configuration/entityTypes/Individual/attributes/LastName",
"value": "Smith",
"URI": "entities/00005KL/attributes/LastName/0"
}
],
"FirstName": [
{
"type": "configuration/entityTypes/Individual/attributes/FirstName",
"value": "Smith",
"URI": "entities/00005KL/attributes/FirstName/1"
}
]
},
"crosswalks": [
{
"URI": "entities/12345/crosswalks/1",
"type": "configuration/sources/RELTIO",
"value": "12345",
"attributes": [
"entities/00005KL/attributes/LastName/0"
]
},
{
"URI": "entities/12345/crosswalks/2",
"type": "configuration/sources/RELTIO",
"value": "456789",
"attributes": [
"entities/00005KL/attributes/FirstName/1"
]
}
]
}
}