jira.js
    Preparing search index...

    Function searchAndReconsileIssuesUsingJql

    • Searches for issues using JQL. Recent updates might not be immediately visible in the returned search results. If you need read-after-write consistency, you can utilize the reconcileIssues parameter to ensure stronger consistency assurances. This operation can be accessed anonymously.

      If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

      Permissions required: Issues are included in the response where the user has:

      Parameters

      • client: Client
      • Optionalparameters: {
            expand?:
                | string
                | string[]
                | string & {}
                | (
                    | string & {}
                    | "schema"
                    | "operations"
                    | "changelog"
                    | "editmeta"
                    | "names"
                    | "renderedFields"
                    | "transitions"
                    | "versionedRepresentations"
                )[];
            failFast?: boolean;
            fields?: string[];
            fieldsByKeys?: boolean;
            jql?: string;
            maxResults?: number;
            nextPageToken?: string;
            properties?: string[];
            reconcileIssues?: number[];
        }
        • Optionalexpand?:
              | string
              | string[]
              | string & {}
              | (
                  | string & {}
                  | "schema"
                  | "operations"
                  | "changelog"
                  | "editmeta"
                  | "names"
                  | "renderedFields"
                  | "transitions"
                  | "versionedRepresentations"
              )[]

          Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where expand is specified, expand is defined as a comma-delimited string of values. The expand options are:

          • renderedFields Returns field values rendered in HTML format.
          • names Returns the display name of each field.
          • schema Returns the schema describing a field type.
          • transitions Returns all possible transitions for the issue.
          • operations Returns all possible operations for the issue.
          • editmeta Returns information about how each field can be edited.
          • changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent.
          • versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.

          Examples: "names,changelog" Returns the display name of each field as well as a list of recent updates to an issue.

        • OptionalfailFast?: boolean

          Fail this request early if we can't retrieve all field data.

        • Optionalfields?: string[]

          A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include:

          • *all Returns all fields.
          • *navigable Returns navigable fields.
          • id Returns only issue IDs.
          • Any issue field, prefixed with a minus to exclude.

          The default is id.

          Examples:

          • summary,comment Returns only the summary and comments fields only.
          • -description Returns all navigable (default) fields except description.
          • *all,-comment Returns all fields except comments.

          Multiple fields parameters can be included in a request.

          Note: By default, this resource returns IDs only. This differs from GET issue where the default is all fields.

        • OptionalfieldsByKeys?: boolean

          Reference fields by their key (rather than ID). The default is false.

        • Optionaljql?: string

          A JQL expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction.

          • Example of an unbounded query: order by key desc.
          • Example of a bounded query: assignee = currentUser() order by key.

          Additionally, orderBy clause can contain a maximum of 7 fields.

        • OptionalmaxResults?: number

          The maximum number of items to return per page. To manage page size, API may return fewer items per page where a large number of fields or properties are requested. The greatest number of items returned per page is achieved when requesting id or key only. It returns max 5000 issues.

        • OptionalnextPageToken?: string

          The token for a page to fetch that is not the first page. The first page has a nextPageToken of null. Use the nextPageToken to fetch the next page of issues.

          Note: The nextPageToken field is not included in the response for the last page, indicating there is no next page.

        • Optionalproperties?: string[]

          A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.

        • OptionalreconcileIssues?: number[]

          Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids. This list of ids should be consistent with each paginated request across different pages.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast?: boolean;
              issues?: {
                  changelog?: {
                      histories?: {
                          author?: (...)
                          | (...);
                          created?: (...) | (...);
                          historyMetadata?: (...) | (...);
                          id?: (...) | (...);
                          items?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      maxResults?: number;
                      startAt?: number;
                      total?: number;
                      [key: string]: unknown;
                  };
                  editmeta?: { fields?: Record<string, any>; [key: string]: unknown };
                  expand?: string;
                  fields?: Record<string, any>;
                  fieldsToInclude?: {
                      actuallyIncluded?: string[];
                      excluded?: string[];
                      included?: string[];
                      [key: string]: unknown;
                  };
                  id?: string;
                  key?: string;
                  names?: Record<string, any>;
                  operations?: { linkGroups?: LinkGroup[]; [key: string]: unknown };
                  properties?: Record<string, any>;
                  renderedFields?: Record<string, any>;
                  schema?: Record<string, any>;
                  self?: string;
                  transitions?: {
                      expand?: string;
                      fields?: Record<string, any>;
                      hasScreen?: boolean;
                      id?: string;
                      isAvailable?: boolean;
                      isConditional?: boolean;
                      isGlobal?: boolean;
                      isInitial?: boolean;
                      looped?: boolean;
                      name?: string;
                      to?: {
                          description?: (...) | (...);
                          iconUrl?: (...) | (...);
                          id?: (...) | (...);
                          name?: (...) | (...);
                          scope?: (...) | (...);
                          self?: (...) | (...);
                          statusCategory?: (...) | (...);
                          untranslatedName?: (...) | (...);
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  }[];
                  versionedRepresentations?: Record<string, any>;
                  [key: string]: unknown;
              }[];
              names?: Record<string, any>;
              nextPageToken?: string | null;
              schema?: Record<string, any>;
              warnings?: {
                  details?: {
                      actual?: number;
                      arguments?: string;
                      clause?: string;
                      limit?: number;
                      [key: string]: unknown;
                  };
                  message?: string;
                  type?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility