jira.js
    Preparing search index...

    Function getProjectVersionsPaginated

    • 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

      • client: Client
      • parameters: {
            expand?:
                | string
                | string[]
                | string & {}
                | (string & {} | "approvers" | "driver" | "operations" | "issuesstatus")[];
            maxResults?: number;
            orderBy?:
                | "name"
                | "description"
                | "sequence"
                | string & {}
                | "releaseDate"
                | "startDate"
                | "-description"
                | "+description"
                | "-name"
                | "+name"
                | "-releaseDate"
                | "+releaseDate"
                | "-sequence"
                | "+sequence"
                | "-startDate"
                | "+startDate";
            projectIdOrKey: string;
            query?: string;
            startAt?: number;
            status?: string
            | string[];
        }
        • Optionalexpand?:
              | string
              | string[]
              | string & {}
              | (string & {} | "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.
        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • OptionalorderBy?:
              | "name"
              | "description"
              | "sequence"
              | string & {}
              | "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.
        • projectIdOrKey: string

          The project ID or project key (case sensitive).

        • Optionalquery?: string

          Filter the results using a literal string. Versions with matching name or description are returned (case insensitive).

        • OptionalstartAt?: number

          The index of the first item to return in a page of results (page offset).

        • Optionalstatus?: 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.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast: boolean;
              maxResults: number;
              nextPage?: string;
              self?: string;
              startAt: number;
              total: number;
              values: {
                  approvers?: {
                      accountId?: string;
                      declineReason?: string;
                      description?: string;
                      status?: string;
                      [key: string]: unknown;
                  }[];
                  archived?: boolean;
                  description?: string;
                  driver?: string;
                  expand?: string;
                  id?: string;
                  issuesStatusForFixVersion?: {
                      done?: number;
                      inProgress?: number;
                      toDo?: number;
                      unmapped?: number;
                      [key: string]: unknown;
                  };
                  moveUnfixedIssuesTo?: string;
                  name?: string;
                  operations?: {
                      href?: string;
                      iconClass?: string;
                      id?: string;
                      label?: string;
                      styleClass?: string;
                      title?: string;
                      weight?: number;
                      [key: string]: unknown;
                  }[];
                  overdue?: boolean;
                  projectId?: number;
                  released?: boolean;
                  releaseDate?: string;
                  self?: string;
                  startDate?: string;
                  userReleaseDate?: string;
                  userStartDate?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility