Unify and manage your data

Manage configuration sub-resources

Learn how to manage sub-resources of configuration objects using the Configuration API, including cleanse configurations and survivorship groups.

Overview

You can retrieve, update, and delete configuration sub-resources using the Configuration API. These endpoints let you manage the following granular definitions tied to entityTypes:

  • cleanseConfig

  • survivorshipGroups

  • matchGroups

You can also manage survivorshipGroups for relationTypes.

Cleanse configuration for entityType

The following operations are supported for Cleanse Config in an Entity type

GET /configuration/entityTypes/{entityTypeName}/cleanseConfig
PUT /configuration/entityTypes/{entityTypeName}/cleanseConfig
DELETE /configuration/entityTypes/{entityTypeName}/cleanseConfig

Behavior

  • GET returns the cleanse configuration for the entity type.
  • PUT updates the cleanse configuration and returns 200 OK.
  • DELETE removes the cleanseConfigand returns 204 No Content.

Survivorship groups

The following operations are supported for Survivorship groups in an Entity / Relationship type

GET /configuration/entityTypes/{entityTypeName}/survivorshipGroups
PUT /configuration/entityTypes/{entityTypeName}/survivorshipGroups/{groupUri}
DELETE /configuration/entityTypes/{entityTypeName}/survivorshipGroups/{groupUri}
GET /configuration/relationTypes/{relationshipTypeName}/survivorshipGroups
PUT /configuration/relationTypes/{relationshipTypeName}/survivorshipGroups/{groupUri}
DELETE /configuration/relationTypes/{relationshipTypeName}/survivorshipGroups/{groupUri}

Behavior

  • Returns 200 OK with the list of survivorship groups
  • If type is unknown, returns 400 TYPE_IS_NOT_FOUND

Match groups for entity types

The following operations are supported for Match groups in an Entity type

GET /configuration/entityTypes/{entityTypeName}/matchGroups
PUT /configuration/entityTypes/{entityTypeName}/matchGroups
DELETE /configuration/entityTypes/{entityTypeName}/matchGroups/{matchGroupName}

Behavior

  • GET returns the match groups for the entity type.
  • PUT updates the match groups and returns 200 OK.
  • DELETE removes the match groups.

Permissions

All endpoints require the appropriate role-based access:

  • GET: READ access
  • PUT: UPDATE access
  • DELETE: DELETE access