jira.js
    Preparing search index...

    Function getIssuePickerResource

    • 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

      • client: Client
      • Optionalparameters: {
            currentIssueKey?: string;
            currentJQL?: string;
            currentProjectId?: string;
            query?: string;
            showSubTaskParent?: boolean;
            showSubTasks?: boolean;
        }
        • OptionalcurrentIssueKey?: string

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

        • OptionalcurrentJQL?: 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.

        • OptionalcurrentProjectId?: string

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

        • Optionalquery?: string

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

        • OptionalshowSubTaskParent?: boolean

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

        • OptionalshowSubTasks?: boolean

          Indicate whether to include subtasks in the suggestions list.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              sections?: {
                  id?: string;
                  issues?: {
                      id?: number;
                      img?: string;
                      key?: string;
                      keyHtml?: string;
                      summary?: string;
                      summaryText?: string;
                      [key: string]: unknown;
                  }[];
                  label?: string;
                  msg?: string;
                  sub?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility