Function: getIssuesForBoardSprint()

function getIssuesForBoardSprint(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  expand?: string | null;
  issues?: object[];
  maxResults?: number;
  maxResultWindow?: number;
  names?: Record<string, string> | null;
  schema?:   | Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
   }>
     | null;
  startAt?: number;
  total?: number;
  warningMessages?: string[] | null;
}>;

Defined in: src/server/api/board.ts:435

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

Parameter	Type	Description
client	Client	-
parameters	{ boardId: number; expand?: string | string[]; fields?: string | string[]; jql?: string; maxResults?: number; sprintId: number; startAt?: number; validateQuery?: boolean; }	-
parameters.boardId	number	The Id of the board that contains requested issues.
parameters.expand?	string | string[]	A comma-separated list of the parameters to expand.
parameters.fields?	string | string[]	The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
parameters.jql?	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.
parameters.maxResults?	number	The maximum number of sprints to return per page. Default: 50.
parameters.sprintId?	number	The Id of the sprint that contains requested issues.
parameters.startAt?	number	The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.
parameters.validateQuery?	boolean	Specifies whether to validate the JQL query or not. Default: true.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; expand?: string | null; issues?: object[]; maxResults?: number; maxResultWindow?: number; names?: Record<string, string> | null; schema?: | Record<string, { [key: string]: unknown; custom?: string; customId?: number; items?: string; system?: string; type?: string; }> | null; startAt?: number; total?: number; warningMessages?: string[] | null; }>