🔗 EntityRef represents a reference to an entity.

Used for linking telemetry data to external entities or systems. This is useful for correlating telemetry with external databases or systems.

const turtleEntityRef: EntityRef = {
schemaUrl: "https://example.com/turtle-schema/v1",
type: "turtle",
idKeys: ["turtle.id", "turtle.owner"],
descriptionKeys: ["turtle.name", "turtle.type"]
};
interface EntityRef {
    descriptionKeys: string[];
    idKeys: string[];
    schemaUrl: string;
    type: string;
}

Properties

descriptionKeys: string[]

Keys that provide human-readable description

idKeys: string[]

Keys that uniquely identify this entity

schemaUrl: string

URL to the schema defining this entity type

type: string

Type of the entity being referenced