Interface: ActiveSearchInfo
PageInfoApi.ActiveSearchInfo
Description
The active Saved Search or AdHoc Search Information
Properties
- activeRelationalFieldID
- isAdHoc
- savedSearchId
- savedSearchSearchProviderId
- savedSearchSorts
- viewFieldIds
Properties
activeRelationalFieldID
• Optional
activeRelationalFieldID: null
| number
The artifact ID of the adhoc search relational fieldID
isAdHoc
• Optional
isAdHoc: boolean
True if the active search is an adhoc search
savedSearchId
• Optional
savedSearchId: number
The active saved search artifact ID
savedSearchSearchProviderId
• Optional
savedSearchSearchProviderId: number
The artifact ID of the search provider (i.e. Search Index) used by the Saved Search
savedSearchSorts
• Optional
savedSearchSorts: SortMetadata
[]
The saved search sorts
viewFieldIds
• Optional
viewFieldIds: number
[]
The active search's view field IDs