Skip to main content

Interface: QueryFieldInfo

Defined in: packages/sdk/src/types/query-engine-types.ts:291

Properties

category?

optional category: string | null

Defined in: packages/sdk/src/types/query-engine-types.ts:311

Semantic group from the registry (profile/contact/notifications/ communications/workflows/calendar) — drives builder palette grouping. Optional for older API versions; null = uncategorized.


displayName?

optional displayName: string | null

Defined in: packages/sdk/src/types/query-engine-types.ts:305

Human picker label when the path tail is misleading (e.g. "labelId").


enumOptions?

optional enumOptions: QueryEnumOption[] | null

Defined in: packages/sdk/src/types/query-engine-types.ts:303

Labeled value options ({value, label}) for fields whose raw values are meaningless to humans (label/role ids). Value stored in the IR is value; the UI shows label.


enumValues?

optional enumValues: unknown[] | null

Defined in: packages/sdk/src/types/query-engine-types.ts:297


operators

operators: string[]

Defined in: packages/sdk/src/types/query-engine-types.ts:294


path

path: string

Defined in: packages/sdk/src/types/query-engine-types.ts:292


selectable

selectable: boolean

Defined in: packages/sdk/src/types/query-engine-types.ts:296


sortable

sortable: boolean

Defined in: packages/sdk/src/types/query-engine-types.ts:295


type

type: string

Defined in: packages/sdk/src/types/query-engine-types.ts:293