Get Issue Picker Suggestions
GET {{baseUrl}}/rest/api/3/issue/picker?query=<string>¤tJQL=<string>¤tIssueKey=<string>¤tProjectId=<string>&showSubTasks=<boolean>&showSubTaskParent=<boolean>
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 thequery
parameter. -
Current Search
which includes issues that match the JQL expression incurrentJQL
and contain the string in thequery
parameter.
This operation can be accessed anonymously.
Permissions required: None.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
query | string | A string to match against text fields in the issue such as title, description, or comments. | |
currentJQL | string | 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 | 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 | The ID of a project that suggested issues must belong to. | |
showSubTasks | string | Indicate whether to include subtasks in the suggestions list. | |
showSubTaskParent | string | When currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query. |
RESPONSES
status: OK
{"sections":[{"label":"culpa eiusmod Ut aute ullamco","sub":"consecte","id":"aliqua sed","msg":"ea deserunt cillum in proident","issues":[{"id":81942590,"key":"irure anim","keyHtml":"dolor ut ad","img":"eiusmod consequat esse id ut","summary":"dolor sunt in deserunt eiusmod","summaryText":"sunt pariatur nostrud"},{"id":50966605,"key":"sit","keyHtml":"adipisicing aute","img":"fugiat minim ex","summary":"est mollit tempor sint","summaryText":"enim officia"}]},{"label":"in elit minim est amet","sub":"aliqua consequat ex ipsum","id":"amet cillum tempor ipsum","msg":"Excepteur laborum","issues":[{"id":-86776450,"key":"et adipisicing qui mollit dolore","keyHtml":"minim proident Ut","img":"ad occaecat amet","summary":"Duis eu co","summaryText":"ipsum reprehenderit ut"},{"id":68276940,"key":"irure Duis","keyHtml":"esse incididunt in","img":"Lorem laborum ut aute elit","summary":"do","summaryText":"laborum sit sed consequat n"}]}]}