add_element
Add an ArchiMate element to the active model. Specify type and name, optionally set description, folder, properties, or stable ID.
Instructions
Add a new ArchiMate element to the active model.
Call `list_supported_types` to discover valid `element_type` values
if you are not certain. The response `data.id` is the canonical
element ID; use it as `source_id`/`target_id` when adding
relationships and as `element_id` when adding view nodes.
Args:
element_type: A supported ArchiMate element type, e.g.
`BusinessActor`, `BusinessProcess`, `ApplicationComponent`,
`ApplicationService`, `DataObject`, `Node`, `Artifact`,
`Goal`, `Stakeholder`, `Grouping`, `AndJunction`,
`OrJunction`. Use `list_supported_types` for the full list.
name: Element name. Must be a non-empty string.
description: Optional element documentation text.
folder_path: Optional conceptual folder path. Roots are
normalized: `Business`, `/Business`, and `business` resolve
to `/Business`. Sub-folders such as `/Business/Actors` are
preserved.
properties: Optional custom property key-value pairs. Values are
stored as strings.
element_id: Optional stable element ID. When omitted a UUID is
generated. Must be unique across the
*entire* active model — not just within this call, this
batch, or this concept type. An id already used by any
element, relationship, view, node or connection is
rejected. When generating ids across several batches,
namespace them (`bp-`, `ac-`, `tech-`) so batches cannot
collide.
Returns:
Success envelope with `data` shaped like an `ElementDetail`:
`{id, name, type, description, properties, folder,
incoming_relationship_ids, outgoing_relationship_ids}`.
Errors:
`INVALID_ELEMENT_NAME` when `name` is missing or blank.
`InvalidElementTypeError` for an unknown `element_type`.
`ModelNotFoundError` if no model is active.
`ModelOperationError` for a duplicate `element_id` or invalid
folder path.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| element_id | No | ||
| properties | No | ||
| description | No | ||
| folder_path | No | ||
| element_type | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||