Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/jira/src/agile/parameters/getIssuesForBoard.ts>GetIssuesForBoard

A JavaScript/TypeScript wrapper for the JIRA Cloud, Service Desk and Agile REST API
Latest
interface GetIssuesForBoard
import { type GetIssuesForBoard } from "https://deno.land/x/jira@v3.0.2/src/agile/parameters/getIssuesForBoard.ts";

Properties

boardId: number

The ID of the board that contains the requested issues.

optional
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.

optional
maxResults: number

The maximum number of issues to return per page. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated.

optional
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. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.

optional
validateQuery: boolean

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

optional
fields: string[]

The list of fields to return for each issue. By default, all navigable and Agile fields are returned.

optional
expand: string

This parameter is currently not used.