Interface: UIDescribeRequest
@kortexya/reasoninglayer / UIDescribeRequest
Interface: UIDescribeRequest
Section titled “Interface: UIDescribeRequest”Defined in: src/types/ui.ts:259
Request to describe a UI for a sort.
Properties
Section titled “Properties”customizations?
Section titled “customizations?”
optionalcustomizations?:UICustomizationDto[] |null
Defined in: src/types/ui.ts:268
Accumulated customizations, in the engine’s wire shape
({ customization_type: 'modify_props', props_override: { … } }).
Remarks
Section titled “Remarks”Sent verbatim: the keys inside params, props_override and a
component descriptor are the caller’s and are not converted.
loadData?
Section titled “loadData?”
optionalloadData?:boolean
Defined in: src/types/ui.ts:269
maxComponents?
Section titled “maxComponents?”
optionalmaxComponents?:number
Defined in: src/types/ui.ts:270
maxDepth?
Section titled “maxDepth?”
optionalmaxDepth?:number
Defined in: src/types/ui.ts:271
priorityThreshold?
Section titled “priorityThreshold?”
optionalpriorityThreshold?:number
Defined in: src/types/ui.ts:272
query?
Section titled “query?”
optionalquery?:string|null
Defined in: src/types/ui.ts:273
sortId
Section titled “sortId”sortId:
string
Defined in: src/types/ui.ts:274
termId?
Section titled “termId?”
optionaltermId?:string|null
Defined in: src/types/ui.ts:283
Id (a UUID) of the term a detail or form view loads; the view’s values
are that term’s own.
Remarks
Section titled “Remarks”A value that is not a UUID is refused with 400; an id that names no term of the sort answers 404.
viewMode?
Section titled “viewMode?”
optionalviewMode?:string
Defined in: src/types/ui.ts:285
View mode: "form", "table", "detail", "card", "tree".