Interface: UIDataPayload
@kortexya/reasoninglayer / UIDataPayload
Interface: UIDataPayload
Section titled “Interface: UIDataPayload”Defined in: src/types/ui.ts:551
Engine-loaded rows for one OSFQL load query.
Remarks
Section titled “Remarks”The keys of each row are column names from the tenant’s schema (feature names). They are data, so the SDK passes them through verbatim and does not camelCase them.
Properties
Section titled “Properties”columns
Section titled “columns”columns:
string[]
Defined in: src/types/ui.ts:553
Column names, in order.
rows:
Record<string,JsonValue>[]
Defined in: src/types/ui.ts:564
Rows of values; each row maps a column name to its display value.
Remarks
Section titled “Remarks”A row a data view loads carries its term’s id in the column the view
names in its rowKey prop (__osf_term_id for the engine-generated
query; no rowKey means the rows carry no term id). That id
is the UIActionRequest.termId an update_form or delete_record
sends.
termIds?
Section titled “termIds?”
optionaltermIds?:string[]
Defined in: src/types/ui.ts:572
The terms the load query’s program produced (an INSERT or DERIVE it
runs). It is not one id per row: a row’s own term id is in the column
the view’s rowKey prop names. Absent when empty.
totalCount
Section titled “totalCount”totalCount:
number
Defined in: src/types/ui.ts:566
Total count (can be more than rows.length when the load is paginated).