archive_entities
- Category: knowledge
- Access: write
- Audience: ordinary (an ordinary user normally calls this directly)
Purpose
Archive entities by name. Records are preserved in history.
Arguments
Required: entityNames.
-
entityNames. Note: Array of entity names.
Result
JSON object with archived and already_archived counts.
Boundaries
Project-scoped; misses and foreign rows read as not found.
Lifecycle / side effects
Lifecycle only, never physical DELETE.
Errors
Bad shapes rejected. Failures move nothing (atomic).
Example
{
"entityNames": [
"e"
]
}
Result shape:
{
"archived": 1
}