Skip to content
UPG is in early alpha. The specification is still evolving and may change between versions.
Tools/Workspace & Portfolios/list_registry

list_registry

List the canonical shared entities in the portfolio registry. Each row carries id, type, title, optional audience_role, and TWO counts that answer different questions: `instance_count` (inbound `instance_of` edges from PRODUCT graphs) and `registry_edge_count` (the registry's own internal edges on either endpoint, written by `create_registry_edge`). A canonical with `instance_count: 0` is NOT necessarily unreferenced, so check `registry_edge_count` before treating one as safe to retire or re-point. With `include_instances` / `include_edges`, attaches the instances / registry-internal edges themselves. Empty when no registry exists yet.

Workspace & Portfoliosatomic (read-only).

Arguments

typestringoptional

Filter to one entity type (e.g. persona).

include_instancesbooleanoptional

Attach each canonical's product instances (default false).

include_edgesbooleanoptional

Attach each canonical's registry-internal edges, each tagged inbound/outbound (default false).

Returns

Shape
{ registry: Array<{ id, type, title, description?, audience_role?, instance_count, registry_edge_count, instances?, edges? }>, total, by_type }

Returns an empty registry when none exists yet.

See Also