Skip to content
SHAMPOO

Tool catalogue

external_type_register

Write · Ordinary · Knowledge graph

external_type_register

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

Purpose

Register a governed external type (conductor).

Arguments

Required: type.

Optional: description, locale, ref_kind.

  • type. Note: Required lowercase [a-z0-9_] spelling, max 64 (no auto-lowercasing).
  • description. Note: Optional description.
  • locale.
  • ref_kind. Note: Ref shape kind (default ref); novel kinds flagged suggestive.

Result

JSON object with type (plus unknownRefKind for novel kinds).

Boundaries

Governed types are conductor-registered. Instances are project-scoped; misses and foreign rows read as not found. Refs stored, never fetched.

Lifecycle / side effects

Types immutable once governed. Instances and links accumulate; rows are never deleted.

Errors

Bad shapes/transitions rejected. Failures move nothing (atomic).

Example

{
  "type": "dataset"
}

Result shape:

{
  "type": "dataset"
}

See also

external_types_list.

On this page