Skip to content
← Back to Index

enums/definitions/<name>/values/<key> ​

Defines a value in a named enum definition. Enum definitions allow you to define a set of enum values once and reference them from one or more custom fields using the enumDefinition property.

The value schema is the same as local enum values.

Properties ​

PropertyTypeDescription
labelobjectLocalized labels for the value. Keys are locale codes (e.g., default, sv-SE, en-US).
huenumberColor hue for the value tag (0-360 on the HSL color wheel).
setKeystringKey of the category to group this value under. See categories.

Example Value ​

json
{
  "label": {
    "default": "High",
    "sv": "Hög"
  },
  "hue": 0
}

Example: Shared Enum Definition ​

Define an enum and reference it from custom fields on multiple nodes:

yaml
# Define the enum values
uri: /resources/registry/enums/definitions/priority-levels/values/low
spec:
  value:
    label:
      default: Low
    hue: 133
---
uri: /resources/registry/enums/definitions/priority-levels/values/medium
spec:
  value:
    label:
      default: Medium
    hue: 45
---
uri: /resources/registry/enums/definitions/priority-levels/values/high
spec:
  value:
    label:
      default: High
    hue: 0
---
# Reference the definition from a custom field on orders
uri: /resources/registry/graph/order/fields/priority
spec:
  value:
    type: enum
    source: dynamic->'priority'
    enumDefinition: priority-levels
---
# Same definition on tickets
uri: /resources/registry/graph/ticket/fields/priority
spec:
  value:
    type: enum
    source: dynamic->'priority'
    enumDefinition: priority-levels

Both fields will share the same dropdown values. Adding a new value at enums/definitions/priority-levels/values/critical automatically updates both.

Local Overrides ​

Fields that reference an enum definition can still have local enum value overrides at the field level. Local values can override labels or hues for specific fields, or add field-specific values not in the definition.

System-Provided Enum Definitions ​

Some enum definitions are provided automatically by the system:

DefinitionPopulated From
channelsChannel definitions
currenciesCurrency definitions

© 2026 Hantera AB. Org. no.: 559242-9582