Unify and manage your data

Manage configuration sub-resources

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

Overview

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

Change request types

GET /configuration/changeRequestTypes/{typeName}?inheritance=true|false
PUT /configuration/changeRequestTypes/{typeName}
DELETE /configuration/changeRequestTypes/{typeName}

Behavior

  • GET returns 200 OK or 400 TYPE_IS_NOT_FOUND
  • PUT updates the configuration and returns 200 OK
  • DELETE returns 204 No Content or 400 TYPE_IS_NOT_FOUND

Cleanse configuration for entityType

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 cleanseConfig and returns 204 No Content

Survivorship groups

GET /configuration/entityTypes/{entityTypeName}/survivorshipGroups
GET /configuration/relationTypes/{relationshipTypeName}/survivorshipGroups

Behavior

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

Permissions

All endpoints require the appropriate role-based access:

  • GET → READ access
  • PUT → UPDATE access
  • DELETE → DELETE access