Interface ISearchQuery

Public

interface ISearchQuery {
    asOf?: string;
    count?: number;
    countOnly: boolean;
    drafts: boolean;
    entity: string;
    facets?: FACETS[];
    fetchAll: boolean;
    formFields?: IFormField<string | number | boolean>[];
    formGroups?: IFormGroup[];
    page?: number;
    returnFields: string[];
    searchDataType: SearchDataType;
    searchFields: string[];
    sortFields?: ISortField[];
    start?: number;
    supplementary?: ISupplementary[];
    supplementaryGroups?: IDataSearchGroup[];
    text?: string;
    totalCount: boolean;
}

Index

Properties

asOf? count? countOnly drafts entity facets? fetchAll formFields? formGroups? page? returnFields searchDataType searchFields sortFields? start? supplementary? supplementaryGroups? text? totalCount

Properties

`Optional`asOf

asOf?: string

`Optional`count

count?: number

countOnly

countOnly: boolean

drafts

drafts: boolean

entity

entity: string

`Optional`facets

facets?: FACETS[]

fetchAll

fetchAll: boolean

`Optional`formFields

formFields?: IFormField<string | number | boolean>[]

`Optional`formGroups

formGroups?: IFormGroup[]

`Optional`page

page?: number

returnFields

returnFields: string[]

searchDataType

searchDataType: SearchDataType

searchFields

searchFields: string[]

`Optional`sortFields

sortFields?: ISortField[]

`Optional`start

start?: number

`Optional`supplementary

supplementary?: ISupplementary[]

`Optional`supplementaryGroups

supplementaryGroups?: IDataSearchGroup[]

`Optional`text

text?: string

totalCount

totalCount: boolean