Function: getIssuePickerResource()

function getIssuePickerResource(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  sections?: object[];
}>;

Defined in: src/cloud/api/issueSearch.ts:27

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.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ currentIssueKey?: string; currentJQL?: string; currentProjectId?: string; query?: string; showSubTaskParent?: boolean; showSubTasks?: boolean; }	-
parameters.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.
parameters.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.
parameters.currentProjectId?	string	The ID of a project that suggested issues must belong to.
parameters.query?	string	A string to match against text fields in the issue such as title, description, or comments.
parameters.showSubTaskParent?	boolean	When currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query.
parameters.showSubTasks?	boolean	Indicate whether to include subtasks in the suggestions list.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; sections?: object[]; }>