pub struct GroupMemberFieldGroupCreate {Show 13 fields
pub default_value: Value,
pub field_type_code: String,
pub name: String,
pub name_in_signup_form: Option<Option<String>>,
pub note: Option<Option<String>>,
pub note_in_signup_form: Option<Option<String>>,
pub options: Option<Option<Vec<GroupMemberFieldGroupOptionCreate>>>,
pub reference_name: Option<String>,
pub required_in_registration_form: bool,
pub security_level: i64,
pub sort_key: Option<i64>,
pub use_in_registration_form: bool,
pub extra: Map<String, Value>,
}Expand description
Creates a field on memberships of the path group. Its type is fixed after creation. The reference name is generated when omitted; defaults and choices are normalized to the field type.
Fields§
§default_value: ValueDefault value, validated according to fieldTypeCode. Checkbox accepts booleans and supported boolean strings; number accepts numbers or numeric strings. Date/datetime require date/Zulu date-time strings. Text and textarea accept up to 4000 characters; api accepts up to 255. Select/radioselect accept an option name or ID; multiselect accepts an array, comma-separated string or JSON-encoded array of option names/IDs. Responses normalize scalar values to strings and multiselect values to arrays of option-ID strings. Null clears the default.
field_type_code: StringOne of the ten supported field types. Unlike global database fields, text/textarea member fields do not require a length parameter and have a fixed maximum value size of 4000.
Allowed values: api, checkbox, date, datetime, multiselect, number, radioselect, select, text, textarea.
name: StringInternal field name shown to administrators.
name_in_signup_form: Option<Option<String>>Optional field name shown in the signup form. Null or text identical to the internal name/note is stored as null, allowing the internal text to be used.
None leaves the field out, Some(None) sends null.
note: Option<Option<String>>Internal field description.
None leaves the field out, Some(None) sends null.
note_in_signup_form: Option<Option<String>>Optional field description shown in the signup form. Null or text identical to the internal name/note is stored as null, allowing the internal text to be used.
None leaves the field out, Some(None) sends null.
options: Option<Option<Vec<GroupMemberFieldGroupOptionCreate>>>Choices for select, radioselect or multiselect, in display order. Only name is needed; submitted IDs are discarded and new IDs are allocated. Duplicate new names are deduplicated. Omitted/null/empty creates no choices; options for other field types are not retained.
None leaves the field out, Some(None) sends null.
reference_name: Option<String>Optional stable machine-readable key. If omitted, it is generated from the field name.
required_in_registration_form: boolWhether this field is mandatory in the signup form.
security_level: i64Security level required to see and edit this field.
sort_key: Option<i64>Sort order among group member fields. Defaults to 0.
use_in_registration_form: boolWhether this field is shown in the signup form.
extra: Map<String, Value>Fields not described by the spec, e.g. instance-specific DB fields.