GET /rest/api/2/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 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.
Servers
- https://your-domain.atlassian.net
Query parameters
Name | Type | Required | Description |
---|---|---|---|
showSubTasks |
Boolean | No |
Indicate whether to include subtasks in the suggestions list. |
query |
String | No |
A string to match against text fields in the issue such as title, description, or comments. |
currentIssueKey |
String | No |
The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query. |
currentJQL |
String | No |
A JQL query defining a list of issues to search for the query term. Note that |
showSubTaskParent |
Boolean | No |
When |
currentProjectId |
String | No |
The ID of a project that suggested issues must belong to. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.