pub struct RelationshipType {Show 13 fields
pub degree_name_a: String,
pub degree_name_b: String,
pub export_title: Option<String>,
pub include_in_export: bool,
pub name: Option<String>,
pub security_level_id: i64,
pub sort_key: i64,
pub degree_name_a_translated: String,
pub degree_name_b_translated: String,
pub function_keys: Vec<String>,
pub id: i64,
pub name_translated: String,
pub extra: Map<String, Value>,
}Expand description
Definition of a relationship between two persons, such as Parent / Child or Friend / Friend. This is catalog metadata, not an actual relationship between named persons. The two role labels describe its sides; identical stored labels make it undirected in the backend. Security and export settings concern use of relationships of this type.
Fields§
§degree_name_a: StringRole label for side A. Identical labels on both sides make the type undirected.
degree_name_b: StringRole label for side B and counterpart of degreeNameA.
export_title: Option<String>Heading for the combined export column. The export otherwise uses the type name or synthesized role labels.
include_in_export: boolWhether selected export values from both relationship directions are combined in one column. false still permits separate-direction export.
name: Option<String>Stored type name or translation key. Use nameTranslated for the synthesized display label.
security_level_id: i64Security level configured for relationships of this type.
sort_key: i64Primary ascending catalog sort key. Ties are ordered by stored name, not by the translated or synthesized display name.
degree_name_a_translated: StringSide A role label translated for the current language.
degree_name_b_translated: StringSide B role label translated for the current language.
function_keys: Vec<String>Built-in behavior flags; always an array, empty for ordinary custom types. nodelete protects the type from deletion; noduplicate and openduplicate identify types used by duplicate-person handling.
Allowed values: nodelete, noduplicate, openduplicate.
id: i64Relationship-type ID used when creating or reading a relationship between persons.
name_translated: StringTranslated display name, using the translated side labels as a fallback.
extra: Map<String, Value>Fields not described by the spec, e.g. instance-specific DB fields.