GraphEdge

The `GraphEdge` entity.

Definition

TypeScript
interface GraphEdge {
  id: string;
  graphId: string;
  edgeDefinitionId: string;
  sourceNodeId: string;
  targetNodeId: string;
  label: string;
  properties: unknown;
  createdAt: string;
}

Fields

FieldTypeNotes
idstringreadonly required
graphIdstringrequired — Graph instance this edge belongs to.
edgeDefinitionIdstringrequired — Edge type this edge is an instance of.
sourceNodeIdstringrequired — Node the edge originates from.
targetNodeIdstringrequired — Node the edge points to.
labelstringrequired — Human-readable edge label (relationship name).
propertiesunknownrequired — Edge property values, matching the edge-definition schema if any.
createdAtstringreadonly required — ISO-8601 timestamp of creation.