Interface: QueryFieldInfo

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

Properties

category?

optional category: string | null

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

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:293

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:291

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:285

---

operators

operators: string[]

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

---

path

path: string

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

---

selectable

selectable: boolean

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

---

sortable

sortable: boolean

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

---

type

type: string

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