Overview

You can retrieve, update, or delete individual configuration types using the Configuration API. These endpoints provide granular control over tenant-level configuration objects without needing to operate on the full configuration payload.

The following object types are supported:

• entityTypes
• groupTypes
• relationTypes
• graphTypes
• interactionTypes
• categoryTypes

GET an object type definition

GET /configuration/{objectType}/{typeName}?inheritance=true|false

Returns the full configuration definition for the specified type name. You can choose whether to retrieve inherited properties from base types.

Parameters

Responses

• 200 OK – Returns the object type definition.
• 400 TYPE_IS_NOT_FOUND – The specified type does not exist

Update an object type definition

PUT /configuration/{objectType}/{typeName}

Updates the configuration for a specified object type. You can update a definition only when inheritance is disabled for that type.

Permissions

Requires UPDATE permission for the specified type (see access control below).

Responses

• 200 OK – Returns the updated object definition
• 400 TYPE_IS_NOT_FOUND – Type doesn't exist
• 400 VALIDATION_ERROR – Payload is invalid or incompatible

Delete an object type definition

DELETE /configuration/{objectType}/{typeName}

Deletes the specified object type if it exists and is not in use.

Permissions

Requires DELETE access for the object type.

Responses

• 204 No Content – Deletion successful
• 400 TYPE_IS_NOT_FOUND – Type doesn't exist

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

Access control rules

Access checks use the existing Configuration API access model. The following object types enforce permission checks: