Function: getAllVersions()
ts
function getAllVersions(
client,
parameters,
options?
): Promise<{
[key: string]: unknown;
isLast: boolean;
maxResults: number;
startAt: number;
total?: number;
values: object[];
}>;Defined in: src/server/api/board.ts:463
Returns all versions from a board, for a given board Id. This only includes versions that the user has permission to view. Note, if the user does not have permission to view the board, no versions will be returned at all. Returned versions are ordered by the name of the project from which they belong and then by sequence defined by user.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { boardId: number; maxResults?: number; released?: string; startAt?: number; } | - |
parameters.boardId | number | The Id of the board that contains the requested versions. |
parameters.maxResults? | number | The maximum number of versions to return per page. Default: 50. |
parameters.released? | string | Filters results to versions that are either released or unreleased. Valid values: true, false. |
parameters.startAt? | number | The starting index of the returned versions. Base index: 0. |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>