pub struct DbFieldCreate {Show 13 fields
pub delete_on_archive: bool,
pub is_active: bool,
pub is_available_in_routines: Option<bool>,
pub is_new_person_field: bool,
pub length: Option<i64>,
pub line_ending: Option<Option<String>>,
pub name: String,
pub security_level: i64,
pub shorty: Option<Option<String>>,
pub sort_key: i64,
pub use_as_placeholder: bool,
pub field_category_intern_code: String,
pub extra: Map<String, Value>,
}Expand description
Creates a custom database column and field definition, plus an option table for selection types. Checkbox fields require deleteOnArchive=false. Column names are generated from the label and may receive a numeric suffix.
Fields§
§delete_on_archive: boolWhether a person field’s value is cleared on archiving. Cannot be true for a non-nullable field.
is_active: boolWhether the field is enabled for normal use.
is_available_in_routines: Option<bool>Whether routines may use this field.
is_new_person_field: boolWhether the field is available on new-person forms; primarily relevant to person categories.
length: Option<i64>Configured maximum length for text and textarea fields.
line_ending: Option<Option<String>>deprecated in the ChurchTools API
Legacy display-layout setting retained for compatibility.
None leaves the field out, Some(None) sends null.
name: StringStored display name or translation key. nameTranslated is its localized display text.
security_level: i64Security-level ID governing access to this field, resolved from installation masterdata.
shorty: Option<Option<String>>Abbreviated display label.
None leaves the field out, Some(None) sends null.
sort_key: i64Display-order value within its category.
use_as_placeholder: boolWhether the field may be used as a placeholder.
field_category_intern_code: StringField category: f_address (person address/contact), f_church (person church information), f_category (person categories), f_group (group data), f_dep (departments), f_growpath (person growth-path data), or f_datasecurity (person privacy information). These are category codes, not entity IDs.
Allowed values: f_address, f_category, f_church, f_datasecurity, f_dep, f_group, f_growpath.
extra: Map<String, Value>Fields not described by the spec, e.g. instance-specific DB fields.