@project-niffler/kikai-client
    Preparing search index...

    Interface EnrichmentRecord

    A record to push custom data onto a building. Tenant-scoped — each tenant maintains their own enrichment layer on top of Plentiful's base building data.

    Use cases: energy audit results, internal notes, custom scores, program enrollment.

    interface EnrichmentRecord {
        data: Record<string, unknown>;
        provenance: {
            source_systems?: string[];
            update_reason?: string;
            updated_by: string;
        };
        source_label?: string;
        twin_id: string;
    }
    Index

    Properties

    data provenance source_label? twin_id

    Properties

    data: Record<string, unknown>

    Arbitrary key-value data to store alongside the building.

    provenance: {
        source_systems?: string[];
        update_reason?: string;
        updated_by: string;
    }

    Who is pushing this data and why — used for audit trails.

    Type Declaration

    • Optionalsource_systems?: string[]

      List of upstream systems that contributed to this data.

    • Optionalupdate_reason?: string

      Human-readable reason for the update.

    • updated_by: string

      Identifier for the system or user pushing the data.

    source_label?: string

    Optional label for grouping enrichment records (e.g. "energy-audit-2024").

    twin_id: string

    The building ID to enrich. Must exist in the database.

    Settings

    Member Visibility

    On This Page

    Properties