Skip to main content

valuesetDelete

Permanently delete a value set and all its items from the system.

Removes the value set and all associated items in a cascading delete operation. This action cannot be undone and will affect any system components that depend on this value set.

Restrictions: • SYSTEM type value sets cannot be deleted • All associated items will be permanently removed • Operation cannot be reversed once completed • May affect dependent configurations and dropdown lists

Use this mutation with caution when: • Removing obsolete value sets that are no longer needed • Cleaning up test or development configurations • Consolidating duplicate value sets

Possible errors:

  • VALUESET_NOT_FOUND_ERROR: Value set with the specified ID does not exist
  • VALUESET_DELETE_ERROR: Failed to delete the value set due to system error
  • VALUESET_NOT_ALLOWED_TO_MODIFY_ERROR: Attempt to delete SYSTEM type value set

AUTH: Role=[configuration.OWNER]

valuesetDelete(
  id: Int!
): Boolean!

Arguments​

valuesetDelete.id ● Int! non-null scalar​

Unique identifier of the value set to delete.

Must be a positive integer representing a valid, existing value set ID in the system. The value set must be of CUSTOM type to allow deletion.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.