Developer Portal for YouTrack and Hub Help

Suggestion

Represents query suggestion.

Attributes

This table describes attributes of the Suggestion entity.

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

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

Field

Type

Description

id

String

The ID of the query suggestion. Read-only.

completionStart

Int

Start index of inserted string. Read-only. Can be null.

completionEnd

Int

End index of inserted string. Read-only. Can be null.

matchingStart

Int

Start index of the matched string. Read-only. Can be null.

matchingEnd

Int

End index of the matched string. Read-only. Can be null.

caret

Int

Position of the caret after insertion. Read-only. Can be null.

description

String

Description of the suggested item. Read-only. Can be null.

option

String

Suggested option. Read-only. Can be null.

prefix

String

Prefix that should be inserted before the option. Read-only. Can be null.

suffix

String

Suffix that should be inserted after the option. Read-only. Can be null.

group

String

Name of the group for the suggestion. Read-only. Can be null.

icon

String

An icon URI for the item. Read-only. Can be null.

auxiliaryIcon

String

An additional icon URI for the item. Read-only. Can be null.

className

String

Css class name that should be used for the item. Read-only. Can be null.

Last modified: 7 October 2024