Skip to main content

TypeAheadQuery

Properties

NameTypeDescriptionNotes
QueryStringThe type ahead query string used to construct a phrase prefix match query.[required]
FieldStringThe field on which to perform the type ahead search.[required]
NestedTypeStringThe nested type.[optional]
MaxExpansionsInt32The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000.[optional] [default to 10]
SizeInt32The max amount of records the search will return.[optional] [default to 100]
SortStringThe sort order of the returned records.[optional] [default to "desc"]
SortByValueBooleanThe flag that defines the sort type, by count or value.[optional] [default to $false]

Examples

  • Prepare the resource
$TypeAheadQuery = Initialize-PSSailpoint.V2024TypeAheadQuery  -Query Work `
-Field source.name `
-NestedType access `
-MaxExpansions 10 `
-Size 100 `
-Sort asc `
-SortByValue true
  • Convert the resource to JSON
$TypeAheadQuery | ConvertTo-JSON

[Back to top]