Developer Portal for YouTrack and Hub 2021.3 Help

SearchSuggestions

Represents the list of search suggestions for the currently entered search query.

This table describes attributes of the SearchSuggestions entity.

  • To receive an attribute in the response from server, specify it explicitly in the request parameter fields.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

caret

Int

The current caret position. The end of the current search query by default.

ignoreUnresolvedSetting

Boolean

When false, the Hide unresolved issues setting is taken into account for creating search suggestions. When true, this setting is ignored. True when the currently entered search query concerns a state-type field.

query

String

The current search query for which the suggestions are being requested. Can be null.

suggestions

Array of Suggestions

The list of search suggestions for the currently entered search query. Read-only.

folders

Array of IssueFolders

The current search context.

Last modified: 14 September 2021