jira.js
    Preparing search index...

    Function getIssuesForBoardSprint

    • Get all issues you have access to that belong to the sprint from the board. Issue returned from this resource contains additional fields like: sprint, closedSprints, flagged and epic. Issues are returned ordered by rank. JQL order has higher priority than default rank.

      Parameters

      • client: Client
      • parameters: {
            boardId: number;
            expand?: string | string[];
            fields?: string | string[];
            jql?: string;
            maxResults?: number;
            sprintId: number;
            startAt?: number;
            validateQuery?: boolean;
        }
        • boardId: number

          The Id of the board that contains requested issues.

        • Optionalexpand?: string | string[]

          A comma-separated list of the parameters to expand.

        • Optionalfields?: string | string[]

          The list of fields to return for each issue. By default, all navigable and Agile 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.

        • OptionalmaxResults?: number

          The maximum number of sprints to return per page. Default: 50.

        • sprintId: number

          The Id of the sprint that contains requested issues.

        • OptionalstartAt?: number

          The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.

        • OptionalvalidateQuery?: boolean

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

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              expand?: string
              | null;
              issues?: {
                  changelog?: {
                      histories?: {
                          author?: (...) | (...);
                          created?: (...) | (...);
                          historyMetadata?: (...) | (...);
                          id?: (...) | (...);
                          items?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      maxResults?: number;
                      startAt?: number;
                      total?: number;
                      [key: string]: unknown;
                  };
                  editmeta?: {
                      fields?: Record<
                          string,
                          {
                              allowedValues?: (...)
                              | (...);
                              autoCompleteUrl?: (...) | (...);
                              defaultValue?: (...) | (...);
                              fieldId?: (...) | (...);
                              hasDefaultValue?: (...) | (...) | (...);
                              name?: (...) | (...);
                              operations?: (...) | (...);
                              required?: (...) | (...) | (...);
                              schema?: (...) | (...);
                              [key: string]: unknown;
                          },
                      >;
                      [key: string]: unknown;
                  };
                  fields?: Record<string, any>;
                  fieldsToInclude?: { included?: string[]; [key: string]: unknown };
                  id?: string;
                  key?: string;
                  names?: Record<string, string>;
                  operations?: { linkGroups?: LinkGroup[]; [key: string]: unknown };
                  properties?: {
                      properties?: Record<string, string>;
                      [key: string]: unknown;
                  };
                  renderedFields?: Record<string, any>
                  | null;
                  schema?: Record<
                      string,
                      {
                          custom?: string;
                          customId?: number;
                          items?: string;
                          system?: string;
                          type?: string;
                          [key: string]: unknown;
                      },
                  >;
                  self?: string;
                  transitionBeans?: {
                      description?: string;
                      fields?: Record<
                          string,
                          {
                              allowedValues?: ...;
                              autoCompleteUrl?: ...;
                              defaultValue?: ...;
                              fieldId?: ...;
                              hasDefaultValue?: ...;
                              name?: ...;
                              operations?: ...;
                              required?: ...;
                              schema?: ...;
                              [key: ...]: ...;
                          },
                      >;
                      id?: string;
                      name?: string;
                      opsbarSequence?: number;
                      to?: {
                          description?: (...)
                          | (...);
                          iconUrl?: (...) | (...);
                          id?: (...) | (...);
                          name?: (...) | (...);
                          self?: (...) | (...);
                          statusCategory?: (...) | (...);
                          statusColor?: (...) | (...);
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  }[];
                  transitions?: {
                      description?: string;
                      fields?: Record<
                          string,
                          {
                              allowedValues?: ...;
                              autoCompleteUrl?: ...;
                              defaultValue?: ...;
                              fieldId?: ...;
                              hasDefaultValue?: ...;
                              name?: ...;
                              operations?: ...;
                              required?: ...;
                              schema?: ...;
                              [key: ...]: ...;
                          },
                      >;
                      id?: string;
                      name?: string;
                      opsbarSequence?: number;
                      to?: {
                          description?: (...)
                          | (...);
                          iconUrl?: (...) | (...);
                          id?: (...) | (...);
                          name?: (...) | (...);
                          self?: (...) | (...);
                          statusCategory?: (...) | (...);
                          statusColor?: (...) | (...);
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  }[];
                  versionedRepresentations?: Record<string, any>;
                  [key: string]: unknown;
              }[];
              maxResults?: number;
              maxResultWindow?: number;
              names?: Record<string, string>
              | null;
              schema?:
                  | Record<
                      string,
                      {
                          custom?: string;
                          customId?: number;
                          items?: string;
                          system?: string;
                          type?: string;
                          [key: string]: unknown;
                      },
                  >
                  | null;
              startAt?: number;
              total?: number;
              warningMessages?: string[]
              | null;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility