← API reference
CANONICAL TYPE REFERENCE

KnowledgeNote

A single piece of situational knowledge — a fact, caveat, or tip — attached to a concept or a specific entity, and reachable through the knowledge graph from related entities.

Unique identifier for the note.

Tenant that owns this note.

User who authored the note; null for system-generated notes.

Who may see the note once it is live.

Review lifecycle — PENDING notes are hidden from retrieval until confirmed.

Whether the note is attached to a concept or an entity.

The concept this note is about, when kind is CONCEPT; otherwise null.

Entity kind (TypeID prefix, e.g. "workcenter") when kind is ENTITY; otherwise null.

entityIdString

The attached entity when kind is ENTITY — a TypeID whose prefix names the entity kind; otherwise null.

bodyString!

The note's free-text content — the knowledge itself.

How the note entered the system.

Number of times the note has been confirmed. Higher confirmation raises its trust weight in retrieval ranking.

If this note has been replaced, the ID of the note that replaces it; otherwise null.

createdAtString!

ISO-8601 timestamp when the note was created.

updatedAtString!

ISO-8601 timestamp when the note was last modified.

View exact SDL
"""
A single piece of situational knowledge — a fact, caveat, or tip — attached to a concept or a specific entity, and reachable through the knowledge graph from related entities.
"""
type KnowledgeNote @iac_resource(name: "knowledge_note") @iac_ops(create: "createKnowledgeNote", read: "knowledgeNote", update: "updateKnowledgeNote", delete: "deleteKnowledgeNote") {
  """Unique identifier for the note."""
  id: KnowledgeNoteID! @iac_identity(assignedBy: SERVER) @iac_computed
  """Tenant that owns this note."""
  tenantId: TenantID! @iac_computed
  """User who authored the note; null for system-generated notes."""
  authorUserId: UserID @iac_ref(resource: "service_account") @iac_computed
  """Who may see the note once it is live."""
  scope: KnowledgeScope!
  """
  Review lifecycle — PENDING notes are hidden from retrieval until confirmed.
  """
  status: KnowledgeStatus! @iac_createOnly
  """Whether the note is attached to a concept or an entity."""
  kind: KnowledgeAttachmentKind! @iac_createOnly
  """
  The concept this note is about, when `kind` is CONCEPT; otherwise null.
  """
  conceptId: ConceptID @iac_ref(resource: "concept") @iac_createOnly
  """
  Entity kind (TypeID prefix, e.g. "workcenter") when `kind` is ENTITY; otherwise null.
  """
  entityType: String @iac_computed
  """
  The attached entity when `kind` is ENTITY — a TypeID whose prefix names the entity kind; otherwise null.
  """
  entityId: String @iac_createOnly
  """The note's free-text content — the knowledge itself."""
  body: String!
  """How the note entered the system."""
  provenance: KnowledgeProvenance! @iac_createOnly
  """
  Number of times the note has been confirmed. Higher confirmation raises its trust weight in retrieval ranking.
  """
  confirmations: Int! @iac_computed
  """
  If this note has been replaced, the ID of the note that replaces it; otherwise null.
  """
  supersededBy: KnowledgeNoteID @iac_ref(resource: "knowledge_note") @iac_computed
  """ISO-8601 timestamp when the note was created."""
  createdAt: String! @iac_computed
  """ISO-8601 timestamp when the note was last modified."""
  updatedAt: String! @iac_computed
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.