query_elements
Read-only
Filter and retrieve elements from an active ArchiMate model by type, name, or custom properties.
Instructions
Query elements in the active model with optional filters.
All filters are AND-combined. Pass an empty `{}` to list every
element (equivalent to the `pyarchimate://activemodel/elements`
resource).
Supported filter keys:
- `type` (str): Match elements with this exact ArchiMate type,
e.g. `BusinessActor`, `ApplicationComponent`.
- `name_contains` (str): Case-insensitive substring match
against element name.
- `properties_contain` (dict[str, str]): Match elements whose
custom properties contain every provided key/value pair.
Args:
filter_criteria: Dict containing zero or more of the keys
above. Unknown keys are ignored.
Returns:
Success envelope with `data.elements`, a list of
`ElementDetail` objects (`id`, `name`, `type`, `description`,
`properties`, `folder`, `incoming_relationship_ids`,
`outgoing_relationship_ids`).
Errors:
`ModelNotFoundError` if no model is active.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filter_criteria | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||