Interface: ActiveSearchInfo

PageInfoApi.ActiveSearchInfo

Description

The active Saved Search or AdHoc Search Information

Properties

• activeRelationalFieldID
• isAdHoc
• savedSearchId
• savedSearchSearchProviderId
• savedSearchSorts
• viewFieldIds

Properties

activeRelationalFieldID

• OptionalactiveRelationalFieldID: null | number

The artifact ID of the adhoc search relational fieldID

isAdHoc

• OptionalisAdHoc: boolean

True if the active search is an adhoc search

savedSearchId

• OptionalsavedSearchId: number

The active saved search artifact ID

savedSearchSearchProviderId

• OptionalsavedSearchSearchProviderId: number

The artifact ID of the search provider (i.e. Search Index) used by the Saved Search

savedSearchSorts

• OptionalsavedSearchSorts: SortMetadata[]

The saved search sorts

viewFieldIds

• OptionalviewFieldIds: number[]

The active search's view field IDs