Function getBoardByFilterId

getBoardByFilterId(
    client: Client,
    parameters: { filterId: number; maxResults?: number; startAt?: number },
    options?: RequestOptions,
): Promise<
    {
        isLast: boolean;
        maxResults: number;
        startAt: number;
        total: number;
        values: {
            id?: number;
            name?: string;
            self?: string;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Returns any boards which use the provided filter id. This method can be executed by users without a valid software license in order to find which boards are using a particular filter.
Parameters
- client: Client
- parameters: { filterId: number; maxResults?: number; startAt?: number }
  - filterId: number
    
    Filters results to boards that are relevant to a filter. Not supported for next-gen boards.
  - OptionalmaxResults?: number
    
    The maximum number of boards to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details.
  - OptionalstartAt?: number
    
    The starting index of the returned boards. Base index: 0. See the 'Pagination' section at the top of this page for more details.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        isLast: boolean;
        maxResults: number;
        startAt: number;
        total: number;
        values: {
            id?: number;
            name?: string;
            self?: string;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
- Defined in src/agile/api/board.ts:135

Function getBoardByFilterId

Parameters

filterId: number

`Optional`maxResults?: number

`Optional`startAt?: number

Settings

Function getBoardByFilterId

Parameters

filterId: number

OptionalmaxResults?: number

OptionalstartAt?: number

Returns Promise< { isLast: boolean; maxResults: number; startAt: number; total: number; values: { id?: number; name?: string; self?: string; [key: string]: unknown; }[]; [key: string]: unknown; },>

Settings

`Optional`maxResults?: number

`Optional`startAt?: number

Returns Promise<
{
isLast: boolean;
maxResults: number;
startAt: number;
total: number;
values: {
id?: number;
name?: string;
self?: string;
[key: string]: unknown;
}[];
[key: string]: unknown;
},
>