Function: getIssuesForBoard()

function getIssuesForBoard(
   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:247

Returns all issues from a board, for a given board Id. 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. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ boardId: number; expand?: string; fields?: string | string[]; jql?: string; maxResults?: number; startAt?: number; validateQuery?: boolean; }	-
parameters.boardId	number	The Id of the board that contains the requested issues.
parameters.expand?	string	This parameter is currently not used.
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 issues to return per page. Default: 50.
parameters.startAt?	number	The starting index of the returned issues. Base index: 0.
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; }>