Function: getProjectVersionsPaginated()

function getProjectVersionsPaginated(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;

Defined in: src/cloud/api/projectVersions.ts:38

Returns a paginated list of all versions in a project. See the Get project versions resource if you want to get a full list of versions without pagination.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ expand?: | string & object | "approvers" | "driver" | "operations" | "issuesstatus" | ( | string & object | "approvers" | "driver" | "operations" | "issuesstatus")[]; maxResults?: number; orderBy?: | "name" | "description" | "sequence" | string & object | "releaseDate" | "startDate" | "-description" | "+description" | "-name" | "+name" | "-releaseDate" | "+releaseDate" | "-sequence" | "+sequence" | "-startDate" | "+startDate"; projectIdOrKey: string; query?: string; startAt?: number; status?: string | string[]; }	-
parameters.expand?	| string & object | "approvers" | "driver" | "operations" | "issuesstatus" | ( | string & object | "approvers" | "driver" | "operations" | "issuesstatus")[]	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: - issuesstatus Returns the number of issues in each status category for each version. - operations Returns actions that can be performed on the specified version. - driver Returns the Atlassian account ID of the version driver. - approvers Returns a list containing the approvers for this version.
parameters.maxResults?	number	The maximum number of items to return per page.
parameters.orderBy?	| "name" | "description" | "sequence" | string & object | "releaseDate" | "startDate" | "-description" | "+description" | "-name" | "+name" | "-releaseDate" | "+releaseDate" | "-sequence" | "+sequence" | "-startDate" | "+startDate"	Order the results by a field: - description Sorts by version description. - name Sorts by version name. - releaseDate Sorts by release date, starting with the oldest date. Versions with no release date are listed last. - sequence Sorts by the order of appearance in the user interface. - startDate Sorts by start date, starting with the oldest date. Versions with no start date are listed last.
parameters.projectIdOrKey?	string	The project ID or project key (case sensitive).
parameters.query?	string	Filter the results using a literal string. Versions with matching name or description are returned (case insensitive).
parameters.startAt?	number	The index of the first item to return in a page of results (page offset).
parameters.status?	string | string[]	A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are released, unreleased, and archived.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>