provider Issue search GET
/rest/api/3/issue/picker @utdk/jira
/rest/api/3/issue/picker Get issue picker suggestions
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](#permissions) required:** None.
- query query
- A string to match against text fields in the issue such as title, description, or comments.
- string
- currentJQL query
- 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.
- string
- currentIssueKey query
- The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.
- string
- currentProjectId query
- The ID of a project that suggested issues must belong to.
- string
- showSubTasks query
- Indicate whether to include subtasks in the suggestions list.
- boolean
- showSubTaskParent query
- When `currentIssueKey` is a subtask, whether to include the parent issue in the suggestions if it matches the query.
- boolean
Try it
Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import jira from '@utdk/jira';
await jira.getissuepickerresource()