Skip to content

Function: getIssuesWithoutEpicForBoard()

ts
function getIssuesWithoutEpicForBoard(client, parameters): Promise<{
[key: string]: unknown;
  expand?: string;
  isLast: boolean;
  issues: object[];
  names?: Record<string, any>;
  nextPageToken?: string;
  schema?: Record<string, any>;
  warningMessages?: string[];
}>;

Defined in: src/agile/api/board.ts:281

Returns all issues that do not belong to any epic on a board, for a 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. 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

ParameterTypeDescription
clientClient-
parameters{ boardId: number; expand?: string | string[]; fields?: Record<string, any>[]; jql?: string; maxResults?: number; nextPageToken?: string; reconcileIssues?: number[]; validateQuery?: boolean; }-
parameters.boardIdnumberThe ID of the board that contains the requested issues.
parameters.expand?string | string[]A comma-separated list of the parameters to expand.
parameters.fields?Record<string, any>[]The list of fields to return for each issue. By default, all navigable and Software project fields are returned.
parameters.jql?stringFilters 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.
parameters.maxResults?numberThe 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.
parameters.nextPageToken?stringThe 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.
parameters.reconcileIssues?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.
parameters.validateQuery?booleanSpecifies whether to validate the JQL query or not. Default: true.

Returns

Promise<{ [key: string]: unknown; expand?: string; isLast: boolean; issues: object[]; names?: Record<string, any>; nextPageToken?: string; schema?: Record<string, any>; warningMessages?: string[]; }>