jira.js
    Preparing search index...

    Function getAllDashboards

    • Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

      This operation can be accessed anonymously.

      Permissions required: None.

      Parameters

      • client: Client
      • Optionalparameters: {
            filter?: string & {} | "favourite" | "my";
            maxResults?: number;
            startAt?: number;
        }
        • Optionalfilter?: string & {} | "favourite" | "my"

          The filter applied to the list of dashboards. Valid values are:

          • favourite Returns dashboards the user has marked as favorite.
          • my Returns dashboards owned by the user.
        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • OptionalstartAt?: number

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

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              dashboards?: {
                  automaticRefreshMs?: number;
                  description?: string;
                  editPermissions?: {
                      group?: {
                          groupId?: (...)
                          | (...)
                          | (...);
                          name?: (...) | (...);
                          self?: (...) | (...);
                          [key: string]: unknown;
                      };
                      id?: number;
                      project?: {
                          archived?: (...)
                          | (...)
                          | (...);
                          archivedBy?: (...) | (...);
                          archivedDate?: (...) | (...);
                          assigneeType?: (...) | (...) | (...) | (...);
                          avatarUrls?: (...) | (...);
                          components?: (...) | (...);
                          deleted?: (...) | (...) | (...);
                          deletedBy?: (...) | (...);
                          deletedDate?: (...) | (...);
                          description?: (...) | (...);
                          email?: (...) | (...);
                          entityId?: (...) | (...);
                          expand?: (...) | (...);
                          favourite?: (...) | (...) | (...);
                          id?: (...) | (...);
                          insight?: (...) | (...);
                          isPrivate?: (...) | (...) | (...);
                          issueTypeHierarchy?: (...) | (...);
                          issueTypes?: (...) | (...);
                          key?: (...) | (...);
                          landingPageInfo?: (...) | (...);
                          lead?: (...) | (...);
                          name?: (...) | (...);
                          permissions?: (...) | (...);
                          projectCategory?: (...) | (...);
                          projectTypeKey?: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                          properties?: (...) | (...);
                          retentionTillDate?: (...) | (...);
                          roles?: (...) | (...);
                          self?: (...) | (...);
                          simplified?: (...) | (...) | (...);
                          style?: (...) | (...) | (...) | (...);
                          url?: (...) | (...);
                          uuid?: (...) | (...);
                          versions?: (...) | (...);
                          [key: string]: unknown;
                      };
                      role?: {
                          actors?: (...)
                          | (...);
                          admin?: (...) | (...) | (...);
                          currentUserRole?: (...) | (...) | (...);
                          default?: (...) | (...) | (...);
                          description?: (...) | (...);
                          id?: (...) | (...);
                          name?: (...) | (...);
                          roleConfigurable?: (...) | (...) | (...);
                          scope?: (...) | (...);
                          self?: (...) | (...);
                          translatedName?: (...) | (...);
                          [key: string]: unknown;
                      };
                      type: | "global"
                      | "user"
                      | "group"
                      | string & {}
                      | "project"
                      | "projectRole"
                      | "loggedin"
                      | "authenticated"
                      | "project-unknown";
                      user?: {
                          accountId?: (...)
                          | (...);
                          active?: (...) | (...) | (...);
                          avatarUrls?: (...) | (...);
                          displayName?: (...) | (...);
                          self?: (...) | (...);
                          [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?: (...)
                          | (...)
                          | (...);
                          name?: (...) | (...);
                          self?: (...) | (...);
                          [key: string]: unknown;
                      };
                      id?: number;
                      project?: {
                          archived?: (...)
                          | (...)
                          | (...);
                          archivedBy?: (...) | (...);
                          archivedDate?: (...) | (...);
                          assigneeType?: (...) | (...) | (...) | (...);
                          avatarUrls?: (...) | (...);
                          components?: (...) | (...);
                          deleted?: (...) | (...) | (...);
                          deletedBy?: (...) | (...);
                          deletedDate?: (...) | (...);
                          description?: (...) | (...);
                          email?: (...) | (...);
                          entityId?: (...) | (...);
                          expand?: (...) | (...);
                          favourite?: (...) | (...) | (...);
                          id?: (...) | (...);
                          insight?: (...) | (...);
                          isPrivate?: (...) | (...) | (...);
                          issueTypeHierarchy?: (...) | (...);
                          issueTypes?: (...) | (...);
                          key?: (...) | (...);
                          landingPageInfo?: (...) | (...);
                          lead?: (...) | (...);
                          name?: (...) | (...);
                          permissions?: (...) | (...);
                          projectCategory?: (...) | (...);
                          projectTypeKey?: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                          properties?: (...) | (...);
                          retentionTillDate?: (...) | (...);
                          roles?: (...) | (...);
                          self?: (...) | (...);
                          simplified?: (...) | (...) | (...);
                          style?: (...) | (...) | (...) | (...);
                          url?: (...) | (...);
                          uuid?: (...) | (...);
                          versions?: (...) | (...);
                          [key: string]: unknown;
                      };
                      role?: {
                          actors?: (...)
                          | (...);
                          admin?: (...) | (...) | (...);
                          currentUserRole?: (...) | (...) | (...);
                          default?: (...) | (...) | (...);
                          description?: (...) | (...);
                          id?: (...) | (...);
                          name?: (...) | (...);
                          roleConfigurable?: (...) | (...) | (...);
                          scope?: (...) | (...);
                          self?: (...) | (...);
                          translatedName?: (...) | (...);
                          [key: string]: unknown;
                      };
                      type: | "global"
                      | "user"
                      | "group"
                      | string & {}
                      | "project"
                      | "projectRole"
                      | "loggedin"
                      | "authenticated"
                      | "project-unknown";
                      user?: {
                          accountId?: (...)
                          | (...);
                          active?: (...) | (...) | (...);
                          avatarUrls?: (...) | (...);
                          displayName?: (...) | (...);
                          self?: (...) | (...);
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  }[];
                  systemDashboard?: boolean;
                  view?: string;
                  [key: string]: unknown;
              }[];
              maxResults?: number;
              next?: string;
              prev?: string;
              startAt?: number;
              total?: number;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility