pub struct DbFieldsResource<'a> { /* private fields */ }Expand description
client.db_fields()
Implementations§
Source§impl<'a> DbFieldsResource<'a>
impl<'a> DbFieldsResource<'a>
pub fn options(&self) -> DbFieldsOptionsResource<'a>
Sourcepub fn create(&self, body: &DbFieldCreate) -> Result<DbField>
pub fn create(&self, body: &DbFieldCreate) -> Result<DbField>
Create a database field
POST /dbfields
Creates an installation-specific field definition and database column. Selection types also create an option table with one initial choice. Checkbox fields are non-nullable and cannot be cleared on archive.
§Example
let body = models::DbFieldCreate {
delete_on_archive: true,
is_active: true,
is_new_person_field: true,
name: "Dietary notes".into(),
security_level: 1,
sort_key: 50,
use_as_placeholder: false,
field_category_intern_code: "f_address".into(),
..Default::default()
};
let result = client.db_fields().create(&body)?;
println!("{}", result.name);Sourcepub fn delete(&self, field_id: impl Display) -> Result<()>
pub fn delete(&self, field_id: impl Display) -> Result<()>
Delete a database field
DELETE /dbfields/{fieldId}
Deletes a field definition, its physical database column and all values stored in that column; also removes its group-person-field mappings and custom selection table if present. Protected built-in fields cause a conflict.
§Example
client.db_fields().delete(200)?;Sourcepub fn get(&self, field_id: impl Display) -> Result<DbField>
pub fn get(&self, field_id: impl Display) -> Result<DbField>
Get a database-field definition
GET /dbfields/{fieldId}
Returns one database-field definition, including its type, category and API key.
§Example
let db_field = client.db_fields().get(200)?;
println!("{}", db_field.name);Sourcepub fn list(&self) -> Result<Vec<DbField>>
pub fn list(&self) -> Result<Vec<DbField>>
List database-field definitions
GET /dbfields
Lists built-in and custom field definitions, not the values stored on individual persons or groups. Use categories[] to restrict the result and include[]=options to expand available choices.
Use Self::list_with to pass query parameters.
§Example
for db_field in client.db_fields().list()? {
println!("{}", db_field.name);
}Sourcepub fn list_with(&self, query: &GetDbfieldsQuery) -> Result<Vec<DbField>>
pub fn list_with(&self, query: &GetDbfieldsQuery) -> Result<Vec<DbField>>
List database-field definitions
Like Self::list, with query parameters.
GET /dbfields
Lists built-in and custom field definitions, not the values stored on individual persons or groups. Use categories[] to restrict the result and include[]=options to expand available choices.
Sourcepub fn update(
&self,
field_id: impl Display,
body: &DbFieldUpdate,
) -> Result<DbField>
pub fn update( &self, field_id: impl Display, body: &DbFieldUpdate, ) -> Result<DbField>
Update a database field
PUT /dbfields/{fieldId}
Updates a database-field definition. The existing field determines its type. Installation-created person fields can move between f_address, f_church, f_category and f_datasecurity.
§Example
let body = models::DbFieldUpdate {
delete_on_archive: true,
is_new_person_field: true,
security_level: 1,
sort_key: 50,
use_as_placeholder: false,
..Default::default()
};
let result = client.db_fields().update(200, &body)?;
println!("{}", result.name);