Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Description

Excerpt
hiddentrue
Gets the future and active sprints from the board with the provided id.

...

Retrieves a list of all open or active sprints within a project, offering an overview of ongoing sprint activities.

Retrieves a list of all open or active sprints within a project, offering an overview of ongoing sprint activities.

Parameters

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

Parameter name

Type

Required

Description

boardId

intInteger

Yes

The board id

Return Type

...

Returns the future and active sprints structures.

Example

Code Block
languagejs
JSprint [] sprints = getAllOpenSprints(12345);
for(JSprint s in sprints) {
    runnerLog("Id: " + s.id);
    runnerLog("Name: " + s.name);
}

Note

1. If there is no board with that name or id, an exception will be raised. 2. The user must have sufficient permissions to view the board.

...