delete_relationship
Remove an ArchiMate relationship from the active model, including any associated visual connections, using its ID.
Instructions
Delete an ArchiMate relationship from the active model.
pyArchimate also removes any visual connections that referenced the
deleted relationship.
Args:
relationship_id: ID of the relationship to delete.
Returns:
Success envelope with `data.deleted=true`.
Errors:
`RelationshipNotFoundError` when `relationship_id` is unknown.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"relationship_id": "<relationship_id>"
},
"name": "delete_relationship"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| relationship_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||