Interface: ListTermsQuery
@kortexya/reasoninglayer / ListTermsQuery
Interface: ListTermsQuery
Section titled “Interface: ListTermsQuery”Defined in: src/resources/terms.ts:49
Which terms TermsClient.listTerms returns, and the window over them.
Properties
Section titled “Properties”includeDerived?
Section titled “includeDerived?”
optionalincludeDerived?:boolean
Defined in: src/resources/terms.ts:79
Include the rule conclusions this process has materialised.
Remarks
Section titled “Remarks”⚠️ The engine’s default here is true, the OPPOSITE of
FindBySortRequest.includeDerived. Omit this and you get the
conclusions; send false for the asserted rows alone. Each conclusion
carries TermDto.origin 'derived' and, when the engine recorded
one, TermDto.derivedBy.
The route does not chain. It reports what the last chain left, so after a restart the derived half is empty until something chains again.
Default Value
Section titled “Default Value”true (the engine’s default — the SDK sends nothing when
this is omitted)
limit?
Section titled “limit?”
optionallimit?:number
Defined in: src/resources/terms.ts:51
Max terms to return; omit for all, hard-capped at 10000.
offset?
Section titled “offset?”
optionaloffset?:number
Defined in: src/resources/terms.ts:53
Zero-based index of the first term (default 0).
sortName?
Section titled “sortName?”
optionalsortName?:string
Defined in: src/resources/terms.ts:62
Only terms of this EXACT sort; omit for every sort.
Remarks
Section titled “Remarks”A member of a SUBSORT is not answered — this is an equality filter on the term’s own sort, not a lattice browse. For the polymorphic browse (a sort and everything below it) use QueryClient.findBySortPage.