query_relationships
Read-only
Retrieve relationships from the active ArchiMate model, filtering by type, source, or target element to find specific connections.
Instructions
Query relationships in the active model with optional filters.
All filters are AND-combined. Pass an empty `{}` to list every
relationship (equivalent to the
`pyarchimate://activemodel/relationships` resource).
Supported filter keys:
- `type` (str): Match relationships with this exact pyArchimate
relationship type, e.g. `Serving`, `Composition`,
`Assignment`. The `Relationship` suffix is not used.
- `source_id` (str): Match relationships whose source element
UUID equals this value.
- `target_id` (str): Match relationships whose target element
UUID equals this value.
Args:
filter_criteria: Dict containing zero or more of the keys
above. Unknown keys are ignored.
Returns:
Success envelope with `data.relationships`, a list of
`RelationshipDetail` objects (`id`, `name`, `type`,
`description`, `properties`, `access_type`,
`influence_strength`, `source_element_id`,
`target_element_id`).
Errors:
`InvalidRelationshipTypeError` for an unknown `type`.
`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 | |||