Get issue picker suggestions

GET

/rest/api/3/issue/picker

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:

History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.

Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

This operation can be accessed anonymously.

Permissions required: None.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/issue/picker'

Response Example

200 - Example 1

{
    "sections": [
        {
            "id": "string",
            "issues": [
                {
                    "id": 0,
                    "img": "string",
                    "key": "string",
                    "keyHtml": "string",
                    "summary": "string",
                    "summaryText": "string"
                }
            ],
            "label": "string",
            "msg": "string",
            "sub": "string"
        }
    ]
}

Request

Query Params

query

string

optional

A string to match against text fields in the issue such as title, description, or comments.

currentJQL

string

optional

A JQL query defining a list of issues to search for the query term. Note that username and userkey cannot be used as search terms for this parameter, due to privacy reasons. Use accountId instead.

currentIssueKey

string

optional

The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.

currentProjectId

string

optional

The ID of a project that suggested issues must belong to.

showSubTasks

string

optional

Indicate whether to include subtasks in the suggestions list.

showSubTaskParent

string

optional

When currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query.

Responses

🟢200Returned if the request is successful.

application/json

Body

A list of issues suggested for use in auto-completion.

sections

array[object (IssuePickerSuggestionsIssueType) {5}]

read-onlyoptional

A list of issues for an issue type suggested for use in auto-completion.

string

read-onlyoptional

The ID of the type of issues suggested for use in auto-completion.

issues

array[object (SuggestedIssue) {6}]

read-onlyoptional

A list of issues suggested for use in auto-completion.

label

string

read-onlyoptional

The label of the type of issues suggested for use in auto-completion.

msg

string

read-onlyoptional

If no issue suggestions are found, returns a message indicating no suggestions were found,

sub

string

read-onlyoptional

If issue suggestions are found, returns a message indicating the number of issues suggestions found and returned.

🟠401Returned if the authentication credentials are incorrect or missing.

Modified at 2023-07-13 03:27:27

Get approximate application license count

Check issues against JQL