Generating suggestions displayed when searching for issues

Use this request to get a list of issues whose summary contains the entered text. The response will only contain the issues the user has access to.

GET

https://api.tracker.yandex.net/v3/issues/_suggest

Query format

Before making a request, get permission to access the API.

To get a list of issues, use an HTTP GET request:

GET /v3/issues/_suggest?input=<text>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
Headers

  • Host: Address of the node that provides the API.

  • Authorization: Authorization token about these formats:

    • OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more

    • Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more

  • X-Org-ID or X-Cloud-Org-ID: Organization ID.

    • Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.

    • Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Cloud Organization.

    To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Request parameters

Required parameters

Parameter Description Data type
input Text to filter issues. If there is a space between words in the text, the search results will also include matches where any text appears in place of the space. String

Additional parameters

Parameter Description Data type
queue Key of the queue in which you want to search for issues. String
full Option that allows you to view detailed information for each issue in the list. The default value is false. Required parameter that enables fields, expand, and embed. Boolean
fields Additional issue fields to be passed in the response. You can retrieve the full list of issue fields using the Getting issue parameters request.
To enable this parameter, set full=true in the request.
expand Additional information to include in the response. Possible values:
  • all: All issue parameters.
  • html: Issue description in HTML format.
  • attachments: Attached files.
  • comments: Issue comments.
  • links: Detailed information about issue links.
  • localLinkRefs: Brief information on issue links.
  • aliases: All issue keys.
  • transitions: Workflow transitions between statuses.
  • permissions: User permissions for the issue.
  • sla: Information on SLA rules.
  • update_limits: Issue edit restrictions.
To enable this parameter, set full=true in the request.		 String
embed More detailed information about parameters specified in expand. Possible values:
  • attachments: Attached files
  • comments: Issue comments.
  • transitions: Workflow transitions between statuses
  • sla: Information on SLA rules.
To enable this parameter, set full=true in the request.		 String

Example: Find any available issues whose summary contains the phrase fix errors. The response output should contain the issue parameters: Summary, Status, Assignee, and Followers.

An HTTP GET method is used.

GET  https://api.tracker.yandex.net/v3/issues/_suggest?full=true&fields=summary,status,assignee,followers&input=fix+errors

Response format

If the request is successful, the API returns a response with code 200 OK.

The response body contains a JSON array with information about comments:

[
    {
        "self": "https://api.tracker.yandex.net/v3/issues/DOCSUP-80478",
        "id": "11dac33333333a...",
        "key": "COD-80478",
        "version": 749,
        "summary": "Fix critical errors",
        "followers": [
            {
                "self": "https://api.tracker.yandex.net/v3/users/112000000000....",
                "id": "testId",
                "display": "Tatyana Ivanova",
                "passportUid": 112000000000....
            },
            {
                "self": "https://api.tracker.yandex.net/v3/users/112000000000....",
                "id": "testId2",
                "display": "Evgeny Petrov",
                "passportUid": 112000000000....
            }
        ],
        "assignee": {
            "self": "https://api.tracker.yandex.net/v3/users/112000000000....",
            "id": "testId2",
            "display": "Evgeny Petrov",
            "passportUid": 112000000000....
        },
        "status": {
            "self": "https://api.tracker.yandex.net/v3/statuses/3",
            "id": "3",
            "key": "closed",
            "display": "Closed"
        },
    },
    ...
]
Response parameters
Parameter Description Data type
self Address of the API resource with information about the issue. String
id Issue ID. String
key Issue key. String
version Issue version. Each change to the issue increases its version number. Number
summary Issue name. String
followers Array of objects with information about issue followers. Array
assignee Object with information about the issue's assignee. Map item
status Object with information about the issue status. Map item

followers and assignee object fields

Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. Number
cloudUid Unique user ID in Yandex Cloud Organization String

status object fields

Parameter Description Data type
self Address of the API resource with information about the status. String
id Status ID. String
key Status key. String
display Status name displayed. String

If the request is processed incorrectly, the API returns a response with an error code:

400
One or more request parameters have an invalid value.
401
The user is not authorized. Make sure that actions described in the API access section are performed.
404
The requested object was not found. You may have specified an invalid object ID or key.
Previous
Finding issues
Next
Releasing scroll view resources