jira.js
    Preparing search index...

    Function getDashboardsPaginated

    • Returns a paginated list of dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.

      This operation can be accessed anonymously.

      Permissions required: The following dashboards that match the query parameters are returned:

      • Dashboards owned by the user. Not returned for anonymous users.
      • Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
      • Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
      • Dashboards shared with a public project.
      • Dashboards shared with the public.

      Parameters

      • client: Client
      • Optionalparameters: {
            accountId?: string;
            dashboardName?: string;
            expand?:
                | string
                | string[]
                | string & {}
                | (
                    | "description"
                    | string & {}
                    | "viewUrl"
                    | "owner"
                    | "favourite"
                    | "editPermissions"
                    | "sharePermissions"
                    | "isWritable"
                    | "favouritedCount"
                )[];
            groupId?: string;
            groupname?: string;
            maxResults?: number;
            orderBy?: | "name"
            | "id"
            | "description"
            | string & {}
            | "owner"
            | "-description"
            | "+description"
            | "-name"
            | "+name"
            | "favorite_count"
            | "-favorite_count"
            | "+favorite_count"
            | "-id"
            | "+id"
            | "is_favorite"
            | "-is_favorite"
            | "+is_favorite"
            | "-owner"
            | "+owner";
            projectId?: number;
            startAt?: number;
            status?: "deleted"
            | "active"
            | string & {}
            | "archived";
        }
        • OptionalaccountId?: string

          User account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter.

        • OptionaldashboardName?: string

          String used to perform a case-insensitive partial match with name.

        • Optionalexpand?:
              | string
              | string[]
              | string & {}
              | (
                  | "description"
                  | string & {}
                  | "viewUrl"
                  | "owner"
                  | "favourite"
                  | "editPermissions"
                  | "sharePermissions"
                  | "isWritable"
                  | "favouritedCount"
              )[]

          Use expand to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include:

          • description Returns the description of the dashboard.
          • owner Returns the owner of the dashboard.
          • viewUrl Returns the URL that is used to view the dashboard.
          • favourite Returns isFavourite, an indicator of whether the user has set the dashboard as a favorite.
          • favouritedCount Returns popularity, a count of how many users have set this dashboard as a favorite.
          • sharePermissions Returns details of the share permissions defined for the dashboard.
          • editPermissions Returns details of the edit permissions defined for the dashboard.
          • isWritable Returns whether the current user has permission to edit the dashboard.
        • OptionalgroupId?: string

          Group ID used to return dashboards that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter.

        • Optionalgroupname?: string

          As a group's name can change, use of groupId is recommended. Group name used to return dashboards that are shared with a group that matches sharePermissions.group.name. This parameter cannot be used with the groupId parameter.

        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • OptionalorderBy?:
              | "name"
              | "id"
              | "description"
              | string & {}
              | "owner"
              | "-description"
              | "+description"
              | "-name"
              | "+name"
              | "favorite_count"
              | "-favorite_count"
              | "+favorite_count"
              | "-id"
              | "+id"
              | "is_favorite"
              | "-is_favorite"
              | "+is_favorite"
              | "-owner"
              | "+owner"

          Order the results by a field:

          • description Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use.
          • favourite_count Sorts by dashboard popularity.
          • id Sorts by dashboard ID.
          • is_favourite Sorts by whether the dashboard is marked as a favorite.
          • name Sorts by dashboard name.
          • owner Sorts by dashboard owner name.
        • OptionalprojectId?: number

          Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.

        • OptionalstartAt?: number

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

        • Optionalstatus?: "deleted" | "active" | string & {} | "archived"

          The status to filter by. It may be active, archived or deleted.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast: boolean;
              maxResults: number;
              nextPage?: string;
              self?: string;
              startAt: number;
              total: number;
              values: {
                  automaticRefreshMs?: number;
                  description?: string;
                  editPermissions?: {
                      group?: {
                          groupId?: string
                          | null;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      id?: number;
                      project?: {
                          archived?: boolean;
                          archivedBy?: {
                              accountId?: ...;
                              accountType?: ...;
                              active?: ...;
                              applicationRoles?: ...;
                              appType?: ...;
                              avatarUrls?: ...;
                              displayName?: ...;
                              emailAddress?: ...;
                              expand?: ...;
                              groups?: ...;
                              guest?: ...;
                              locale?: ...;
                              self?: ...;
                              timeZone?: ...;
                              [key: ...]: ...;
                          };
                          archivedDate?: Date;
                          assigneeType?: (...) & (...)
                          | "PROJECT_LEAD"
                          | "UNASSIGNED";
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          components?: (...)[];
                          deleted?: boolean;
                          deletedBy?: {
                              accountId?: ...;
                              accountType?: ...;
                              active?: ...;
                              applicationRoles?: ...;
                              appType?: ...;
                              avatarUrls?: ...;
                              displayName?: ...;
                              emailAddress?: ...;
                              expand?: ...;
                              groups?: ...;
                              guest?: ...;
                              locale?: ...;
                              self?: ...;
                              timeZone?: ...;
                              [key: ...]: ...;
                          };
                          deletedDate?: Date;
                          description?: string;
                          email?: string;
                          entityId?: string;
                          expand?: string;
                          favourite?: boolean;
                          id?: string;
                          insight?: {
                              lastIssueUpdateTime?: ...;
                              totalIssueCount?: ...;
                              [key: ...]: ...;
                          };
                          isPrivate?: boolean;
                          issueTypeHierarchy?: { levels?: ...; [key: ...]: ... };
                          issueTypes?: (...)[];
                          key?: string;
                          landingPageInfo?: {
                              attributes?: ...;
                              boardId?: ...;
                              boardName?: ...;
                              projectKey?: ...;
                              projectType?: ...;
                              queueCategory?: ...;
                              queueId?: ...;
                              queueName?: ...;
                              simpleBoard?: ...;
                              simplified?: ...;
                              url?: ...;
                              [key: ...]: ...;
                          };
                          lead?: {
                              accountId?: ...;
                              accountType?: ...;
                              active?: ...;
                              applicationRoles?: ...;
                              appType?: ...;
                              avatarUrls?: ...;
                              displayName?: ...;
                              emailAddress?: ...;
                              expand?: ...;
                              groups?: ...;
                              guest?: ...;
                              locale?: ...;
                              self?: ...;
                              timeZone?: ...;
                              [key: ...]: ...;
                          };
                          name?: string;
                          permissions?: { canEdit?: ...; [key: ...]: ... };
                          projectCategory?: {
                              description?: ...;
                              id?: ...;
                              name?: ...;
                              self?: ...;
                              [key: ...]: ...;
                          };
                          projectTypeKey?: | (...) & (...)
                          | "software"
                          | "service_desk"
                          | "business"
                          | "product_discovery"
                          | "customer_service";
                          properties?: Record<(...), (...)>;
                          retentionTillDate?: Date;
                          roles?: Record<(...), (...)>;
                          self?: string;
                          simplified?: boolean;
                          style?: "classic" | (...) & (...) | "next-gen";
                          url?: string;
                          uuid?: string;
                          versions?: (...)[];
                          [key: string]: unknown;
                      };
                      role?: {
                          actors?: (...)[];
                          admin?: boolean;
                          currentUserRole?: boolean;
                          default?: boolean;
                          description?: string;
                          id?: number;
                          name?: string;
                          roleConfigurable?: boolean;
                          scope?: { project?: ...; type?: ...; [key: ...]: ... };
                          self?: string;
                          translatedName?: string;
                          [key: string]: unknown;
                      };
                      type: | "global"
                      | "user"
                      | "group"
                      | string & {}
                      | "project"
                      | "projectRole"
                      | "loggedin"
                      | "authenticated"
                      | "project-unknown";
                      user?: {
                          accountId?: string;
                          active?: boolean;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  }[];
                  id?: string;
                  isFavourite?: boolean;
                  isWritable?: boolean;
                  name?: string;
                  owner?: {
                      accountId?: string;
                      active?: boolean;
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      displayName?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  popularity?: number;
                  rank?: number;
                  self?: string;
                  sharePermissions?: {
                      group?: {
                          groupId?: string
                          | null;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      id?: number;
                      project?: {
                          archived?: boolean;
                          archivedBy?: {
                              accountId?: ...;
                              accountType?: ...;
                              active?: ...;
                              applicationRoles?: ...;
                              appType?: ...;
                              avatarUrls?: ...;
                              displayName?: ...;
                              emailAddress?: ...;
                              expand?: ...;
                              groups?: ...;
                              guest?: ...;
                              locale?: ...;
                              self?: ...;
                              timeZone?: ...;
                              [key: ...]: ...;
                          };
                          archivedDate?: Date;
                          assigneeType?: (...) & (...)
                          | "PROJECT_LEAD"
                          | "UNASSIGNED";
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          components?: (...)[];
                          deleted?: boolean;
                          deletedBy?: {
                              accountId?: ...;
                              accountType?: ...;
                              active?: ...;
                              applicationRoles?: ...;
                              appType?: ...;
                              avatarUrls?: ...;
                              displayName?: ...;
                              emailAddress?: ...;
                              expand?: ...;
                              groups?: ...;
                              guest?: ...;
                              locale?: ...;
                              self?: ...;
                              timeZone?: ...;
                              [key: ...]: ...;
                          };
                          deletedDate?: Date;
                          description?: string;
                          email?: string;
                          entityId?: string;
                          expand?: string;
                          favourite?: boolean;
                          id?: string;
                          insight?: {
                              lastIssueUpdateTime?: ...;
                              totalIssueCount?: ...;
                              [key: ...]: ...;
                          };
                          isPrivate?: boolean;
                          issueTypeHierarchy?: { levels?: ...; [key: ...]: ... };
                          issueTypes?: (...)[];
                          key?: string;
                          landingPageInfo?: {
                              attributes?: ...;
                              boardId?: ...;
                              boardName?: ...;
                              projectKey?: ...;
                              projectType?: ...;
                              queueCategory?: ...;
                              queueId?: ...;
                              queueName?: ...;
                              simpleBoard?: ...;
                              simplified?: ...;
                              url?: ...;
                              [key: ...]: ...;
                          };
                          lead?: {
                              accountId?: ...;
                              accountType?: ...;
                              active?: ...;
                              applicationRoles?: ...;
                              appType?: ...;
                              avatarUrls?: ...;
                              displayName?: ...;
                              emailAddress?: ...;
                              expand?: ...;
                              groups?: ...;
                              guest?: ...;
                              locale?: ...;
                              self?: ...;
                              timeZone?: ...;
                              [key: ...]: ...;
                          };
                          name?: string;
                          permissions?: { canEdit?: ...; [key: ...]: ... };
                          projectCategory?: {
                              description?: ...;
                              id?: ...;
                              name?: ...;
                              self?: ...;
                              [key: ...]: ...;
                          };
                          projectTypeKey?: | (...) & (...)
                          | "software"
                          | "service_desk"
                          | "business"
                          | "product_discovery"
                          | "customer_service";
                          properties?: Record<(...), (...)>;
                          retentionTillDate?: Date;
                          roles?: Record<(...), (...)>;
                          self?: string;
                          simplified?: boolean;
                          style?: "classic" | (...) & (...) | "next-gen";
                          url?: string;
                          uuid?: string;
                          versions?: (...)[];
                          [key: string]: unknown;
                      };
                      role?: {
                          actors?: (...)[];
                          admin?: boolean;
                          currentUserRole?: boolean;
                          default?: boolean;
                          description?: string;
                          id?: number;
                          name?: string;
                          roleConfigurable?: boolean;
                          scope?: { project?: ...; type?: ...; [key: ...]: ... };
                          self?: string;
                          translatedName?: string;
                          [key: string]: unknown;
                      };
                      type: | "global"
                      | "user"
                      | "group"
                      | string & {}
                      | "project"
                      | "projectRole"
                      | "loggedin"
                      | "authenticated"
                      | "project-unknown";
                      user?: {
                          accountId?: string;
                          active?: boolean;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  }[];
                  systemDashboard?: boolean;
                  view?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility