External Databases

ExternalDatabase

Represents an external element database containing elements that can be linked to. Facilitates integration with external tools.

db_type_name: Optional[str] = db_type_name

Name in UI of the type of the database (by default: 'External Database').

elements: List[ExternalElement] = elements

elements_type_name: Optional[str] = elements_type_name

Name in UI of the type of the elements (by default: 'External Elements').

id: int = id

last_update: str = last_update

Date/time that this database was last updated/synchronized, represented in ISO 8601 format.

linking_field_name: Optional[str] = linking_field_name

Name in UI of the selection field when linking to an external element (by default: 'Linked external elements').

name: str = name

notes: Optional[str] = notes

ref: Optional[str] = ref

Optional reference, used for linking to external interfaces.

source: Optional[str] = source

Source of the database, for display to the user.

ExternalElement

Represents an external element that can be linked to.

auto_match_patterns: Optional[List[str]] = auto_match_patterns

Patterns (like fname) or regular expressions for auto-matching name and ref fields of design space elements to this external element.

auto_matched_el_ids: Optional[List[int]] = auto_matched_el_ids

id: int = id

metadata: Dict[str, Any] = metadata

Any metadata associated to the external element.

name: str = name

notes: Optional[str] = notes

prop_override: Dict[str, Any] = prop_override

Properties to override on the linked element. Keys are to be specified as in the schema (i.e. camelCase).

qoi_is_input: Optional[bool] = qoi_is_input

Restrict QOI types to input (true) or output (false) types. If not set, no restriction is applied.

ref: Optional[str] = ref

Optional reference, used for linking to external interfaces.

types: List[str] = types

The types of elements this external element can be linked to. To be specified as their class names.