Business 360 REST API Reference > Business 360 REST API > Unmerge API

Unmerge API

Use the unmerge API to unmerge source records from a master record. The API uses the entity-group resource.

To unmerge source records, submit a POST request with the following URI:

<baseApiUrl>/business-entity/public/api/v1/entity-group/<businessEntity>/<businessId>?_keepRelsWith=<value>

The URI uses the following parameters:

•businessEntity. Internal ID of the business entity that the records belong to.
•businessId. Unique identifier of the master record.
•_keepRelsWith. Specifies how to manage relationships between the records that you unmerge.

Use one of the following values:

- BUSINESS_ID. Restores the relationships that the unmerged records had before they were merged.
- REMAINS. Retains the relationships with the master record that the records were unmerged from.

For example, consider two records, Sam and Samuel, which are related and merged. Both records belong to a master record with business ID MDM0000008XJDO. If you unmerge Sam using BUSINESS_ID, the relationships of Sam revert to the original master record to which it belonged before the merge. If the relationships belong to a master record with business ID MDM0000008XJEB, then relationships revert to this master record with business ID MDM0000008XJEB. However, if you unmerge Sam using REMAINS, the relationships of Sam remain with the master record that has business ID MDM0000008XJDO.

Default is REMAINS.

Note: Use BUSINESS_ID to align with the unmerge operation that you perform from the user interface.

The response is in the JSON format.

Request body

To unmerge records, you use a combination of the sourcePKey and sourceSystem parameters in the request body.

To unmerge records, you can use the following parameters in the request body:

Parameter	Type	Description
sourcePKey	String	The primary key of the source record.
sourceSystem	String	Internal ID of the source system to which the record belongs.

Request response

The request response indicates whether a data steward must approve the unmerge action.

The following table lists the response parameter:

Parameter	Type	Description
approvalRequired	Boolean	Specifies whether approval workflow is configured. If the response is true, approval workflow is configured. If the response is false, approval workflow is not configured.

Sample Request

You might use the following request to unmerge the source records of the Person business entity from a master record with the business ID 30144667303107074155788161103:

POST https://use4-mdm.dm-us.informaticacloud.com/business-entity/public/api/v1/entity-group/c360.person/30144667303107074155788161103?_keepRelsWith=BUSINESS_ID\
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

[
{
"sourcePKey": "KR_001",
"sourceSystem": "sales_force"
},
{
"sourcePKey": "KR_003",
"sourceSystem": "sales_force"
}
]

Sample Response

When you make an umerge request, the Business 360 application verifies your user role permissions and the approval workflow configuration. The response indicates whether a data steward must approve the unmerge action.

If no approval workflow is configured, you get the following response:

HTTP/1.1 200 OK
Content-Type: application/json
{
"approvalRequired": false,
}

If approval workflow is configured, you get the following response:

HTTP/1.1 200 OK
Content-Type: application/json
{
"approvalRequired": true,
}