getAllBoards

Owned by Jonathan Muse
Last updated: Aug 06, 2020
1 min read

Availability

This routine is available starting with  SIL Engine™ 4.8.1.

Syntax

getAllBoards([user]);

Description

Returns an array of JBoard type structs for every agile board.

Parameters

Parameter name

Type

Required

Description

UsernameStringNoOptional username parameter to specify a user who can retrieve the board information. By default the current user (user who executed the script) is used and it is possible that the user may not have permissions to view the board.

Return type

JBoard []

Returns an array of JBoard structs.

Example 1

for(JBoard board in getAllBoards("admin")) {
    runnerLog("Board id: " + board.id);
    runnerLog("Board name: " + board.name);
    runnerLog("Board type: " + board.type);
    runnerLog("Board saved filter Id: " + trim(board.savedFilterId));
    //see the JBoard structure type for more fields available for boards
}

See also