Function: getEpics()

function getEpics(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

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

Returns all epics from the board, for the given board Id. This only includes epics that the user has permission to view. Note, if the user does not have permission to view the board, no epics will be returned at all.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ boardId: number; done?: string; maxResults?: number; startAt?: number; }	-
parameters.boardId	number	The Id of the board that contains the requested epics.
parameters.done?	string	Filters results to epics that are either done or not done. Valid values: true, false.
parameters.maxResults?	number	The maximum number of epics to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details.
parameters.startAt?	number	The starting index of the returned epics. Base index: 0. See the 'Pagination' section at the top of this page for more details.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>