jira.js
    Preparing search index...

    Function getIssuesForBacklog

    • Returns all issues from the board's backlog, for the given board ID. Result pagination is token based, using nextPageToken and maxResults. This only includes issues that the user has permission to view. Note, if the user does not have permission to view the board, no issues will be returned at all. The backlog contains incomplete issues that are not assigned to any future or active sprint. Issues returned from this resource include Software project fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.

      Parameters

      • client: Client
      • parameters: {
            boardId: number;
            expand?: string | string[];
            fields?: Record<string, any>[];
            jql?: string;
            maxResults?: number;
            nextPageToken?: string;
            reconcileIssues?: number[];
            validateQuery?: boolean;
        }
        • boardId: number

          The ID of the board that has the backlog containing the requested issues.

        • Optionalexpand?: string | string[]

          A comma-separated list of the parameters to expand.

        • Optionalfields?: Record<string, any>[]

          The list of fields to return for each issue. By default, all navigable and Software project fields are returned.

        • Optionaljql?: string

          Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.

        • OptionalmaxResults?: number

          The maximum number of items to return per page. To manage page size, the API may return fewer items per page where there is a large number of fields or properties returned. 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.

        • 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.

        • OptionalvalidateQuery?: boolean

          Specifies whether to validate the JQL query or not. Default: true.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              expand?: string;
              isLast: boolean;
              issues: {
                  changelog?: {
                      histories?: {
                          author?: {
                              accountId?: ...;
                              accountType?: ...;
                              active?: ...;
                              avatarUrls?: ...;
                              displayName?: ...;
                              emailAddress?: ...;
                              self?: ...;
                              timeZone?: ...;
                              [key: ...]: ...;
                          };
                          created?: Date;
                          historyMetadata?: {
                              activityDescription?: ...;
                              activityDescriptionKey?: ...;
                              actor?: ...;
                              cause?: ...;
                              description?: ...;
                              descriptionKey?: ...;
                              emailDescription?: ...;
                              emailDescriptionKey?: ...;
                              extraData?: ...;
                              generator?: ...;
                              type?: ...;
                              [key: ...]: ...;
                          };
                          id?: string;
                          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?: string;
                          iconUrl?: string;
                          id?: string;
                          name?: string;
                          scope?: { project?: ...; type?: ...; [key: ...]: ... };
                          self?: string;
                          statusCategory?: {
                              colorName?: ...;
                              id?: ...;
                              key?: ...;
                              name?: ...;
                              self?: ...;
                              [key: ...]: ...;
                          };
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  }[];
                  versionedRepresentations?: Record<string, any>;
                  [key: string]: unknown;
              }[];
              names?: Record<string, any>;
              nextPageToken?: string;
              schema?: Record<string, any>;
              warningMessages?: string[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility