Skip to content
Aleksandr Rogov edited this page Jul 15, 2023 · 2 revisions

Interface: Search

Hierarchy

Table of contents

Properties

Properties

entities

Optional entities: string[]

The default table list searches across all Dataverse search–configured tables and columns. The default list is configured by your administrator when Dataverse search is enabled.

Inherited from

SearchQueryBase.entities


facets

Optional facets: string[]

Facets support the ability to drill down into data results after they've been retrieved.


filter

Optional filter: string

Filters are applied while searching data and are specified in standard OData syntax.

Inherited from

SearchQueryBase.filter


orderBy

Optional orderBy: string[]

A list of comma-separated clauses where each clause consists of a column name followed by 'asc' (ascending, which is the default) or 'desc' (descending). This list specifies how to order the results in order of precedence.


returnTotalRecordCount

Optional returnTotalRecordCount: boolean

Specify true to return the total record count; otherwise false. The default is false.


search

search: string

The search parameter value contains the term to be searched for and has a 100-character limit. For suggestions, min 3 characters in addition.

Inherited from

SearchQueryBase.search


searchMode

Optional searchMode: SearchMode

Specifies whether any or all the search terms must be matched to count the document as a match. The default is 'any'.


searchType

Optional searchType: SearchType

The search type specifies the syntax of a search query. Using 'simple' selects simple query syntax and 'full' selects Lucene query syntax. The default is 'simple'.


skip

Optional skip: number

Specifies the number of search results to skip.


top

Optional top: number

Specifies the number of search results to retrieve. The default is 50, and the maximum value is 100.

Clone this wiki locally