Class CreateFieldDefinitionRequest

Whether values for this field can be automatically extracted by AI/OCR services.

A validation constraint expression for values stored in this field.

The error message returned when the constraint is violated.

The currency for numeric fields when Format is Currency.

The default value applied to entries assigned to a template containing this field.

The description of the field.

The type of the field. Required. Cannot be changed via UpdateFieldDefinition; use the ChangeFieldType endpoint to convert between types.

The display format for the field. Defaults to None when omitted.

The custom format pattern. Only meaningful when Format is set to a value that supports custom patterns.

Whether list values should be hidden in the UI. Applies only to list-backed fields.

Whether the field is indexed for searching.

Whether the field is indexed for reporting.

Whether the field supports multiple values.

Whether the field is required on entries assigned to a template containing it.

The maximum length of the field for variable-length data types.

Initial list values to populate. Applies only when FieldType is List. Order is preserved. Use the dedicated ListValues endpoints to manage list values after creation.

The name of the field. Required. Must be unique within the repository.

Initial custom properties to persist atomically with the field. The bag is an opaque application-defined string → string map scoped to the field definition; use it to attach integration metadata or application-specific configuration that should be created together with the field — for example to encode list-field display preferences such as sort order, or to record an external system's identifier for the field. Keys are application-defined; recommend namespaced keys (e.g. myapp.kind, com.acme.field.source) to avoid collisions. Manage after creation via the dedicated /FieldDefinitions/{id}/Properties endpoints. Constraints: empty keys, null values, and control characters are rejected with 400. Maximum 500 entries, 256 chars per key, 1000 chars per value.

Whether the user should be warned when leaving the field blank.