Skip to content
SHAMPOO

Tool catalogue

restore_entities

Write · Ordinary · Knowledge graph

restore_entities

  • Category: knowledge
  • Access: write
  • Audience: ordinary (an ordinary user normally calls this directly)

Purpose

Restore archived entities by name.

Arguments

Required: entityNames.

  • entityNames. Note: Array of entity names to restore.

Result

JSON object with restored (how many revived) and already_active (how many already active).

Boundaries

Only addressed rows visible under the caller's project grants are touched; missing or foreign rows are silently skipped. No cascades either direction.

Lifecycle / side effects

Void-to-active revival in place (same id, no duplicates) through the canonical mutation path with ledger events.

Errors

Malformed arguments are rejected. Failures move nothing (atomic).

Example

{
  "entityNames": [
    "name"
  ]
}

Result shape:

{
  "already_active": 0,
  "restored": 1
}

See also

delete_entities, read_graph, search_nodes.

On this page