jira.js
    Preparing search index...

    Function setFavouriteForFilter

    • Add a filter as a favorite for the user.

      Permissions required: Permission to access Jira, however, the user can only favorite:

      • Filters owned by the user.
      • Filters shared with a group that the user is a member of.
      • Filters shared with a private project that the user has Browse projects project permission for.
      • Filters shared with a public project.
      • Filters shared with the public.

      Parameters

      • client: Client
      • parameters: {
            expand?:
                | string
                | string[]
                | string & {}
                | (string & {} | "sharedUsers" | "subscriptions")[];
            id: number;
        }
        • Optionalexpand?:
              | string
              | string[]
              | string & {}
              | (string & {} | "sharedUsers" | "subscriptions")[]

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

          • sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000].
          • subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].
        • id: number

          The ID of the filter.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              approximateLastUsed?: Date;
              description?: string;
              editPermissions?: {
                  group?: {
                      groupId?: string
                      | null;
                      name?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  id?: number;
                  project?: {
                      archived?: boolean;
                      archivedBy?: {
                          accountId?: string;
                          accountType?: | "unknown"
                          | (...) & (...)
                          | "atlassian"
                          | "app"
                          | "customer";
                          active?: boolean;
                          applicationRoles?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          appType?: string;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          emailAddress?: string;
                          expand?: string;
                          groups?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          guest?: boolean;
                          locale?: string;
                          self?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      archivedDate?: Date;
                      assigneeType?: string & {}
                      | "PROJECT_LEAD"
                      | "UNASSIGNED";
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      components?: {
                          ari?: (...)
                          | (...);
                          assignee?: (...) | (...);
                          assigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
                          description?: (...) | (...);
                          id?: (...) | (...);
                          isAssigneeTypeValid?: (...) | (...) | (...);
                          lead?: (...) | (...);
                          leadAccountId?: (...) | (...);
                          metadata?: (...) | (...);
                          name?: (...) | (...);
                          project?: (...) | (...);
                          projectId?: (...) | (...);
                          realAssignee?: (...) | (...);
                          realAssigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
                          self?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      deleted?: boolean;
                      deletedBy?: {
                          accountId?: string;
                          accountType?: | "unknown"
                          | (...) & (...)
                          | "atlassian"
                          | "app"
                          | "customer";
                          active?: boolean;
                          applicationRoles?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          appType?: string;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          emailAddress?: string;
                          expand?: string;
                          groups?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          guest?: boolean;
                          locale?: string;
                          self?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      deletedDate?: Date;
                      description?: string;
                      email?: string;
                      entityId?: string;
                      expand?: string;
                      favourite?: boolean;
                      id?: string;
                      insight?: {
                          lastIssueUpdateTime?: Date;
                          totalIssueCount?: number;
                          [key: string]: unknown;
                      };
                      isPrivate?: boolean;
                      issueTypeHierarchy?: { levels?: (...)[]; [key: string]: unknown };
                      issueTypes?: {
                          avatarId?: (...) | (...);
                          description?: (...) | (...);
                          entityId?: (...) | (...);
                          hierarchyLevel?: (...) | (...);
                          iconUrl?: (...) | (...);
                          id?: (...) | (...);
                          name?: (...) | (...);
                          scope?: (...) | (...);
                          self?: (...) | (...);
                          subtask?: (...) | (...) | (...);
                          untranslatedName?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      key?: string;
                      landingPageInfo?: {
                          attributes?: Record<(...), (...)>;
                          boardId?: number;
                          boardName?: string;
                          projectKey?: string;
                          projectType?: string;
                          queueCategory?: string;
                          queueId?: number;
                          queueName?: string;
                          simpleBoard?: boolean;
                          simplified?: boolean;
                          url?: string;
                          [key: string]: unknown;
                      };
                      lead?: {
                          accountId?: string;
                          accountType?: | "unknown"
                          | (...) & (...)
                          | "atlassian"
                          | "app"
                          | "customer";
                          active?: boolean;
                          applicationRoles?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          appType?: string;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          emailAddress?: string;
                          expand?: string;
                          groups?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          guest?: boolean;
                          locale?: string;
                          self?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      name?: string;
                      permissions?: { canEdit?: boolean; [key: string]: unknown };
                      projectCategory?: {
                          description?: string;
                          id?: string;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      projectTypeKey?: | string & {}
                      | "software"
                      | "service_desk"
                      | "business"
                      | "product_discovery"
                      | "customer_service";
                      properties?: Record<string, any>;
                      retentionTillDate?: Date;
                      roles?: Record<string, any>;
                      self?: string;
                      simplified?: boolean;
                      style?: "classic" | string & {} | "next-gen";
                      url?: string;
                      uuid?: string;
                      versions?: {
                          approvers?: (...) | (...);
                          archived?: (...) | (...) | (...);
                          description?: (...) | (...);
                          driver?: (...) | (...);
                          expand?: (...) | (...);
                          id?: (...) | (...);
                          issuesStatusForFixVersion?: (...) | (...);
                          moveUnfixedIssuesTo?: (...) | (...);
                          name?: (...) | (...);
                          operations?: (...) | (...);
                          overdue?: (...) | (...) | (...);
                          projectId?: (...) | (...);
                          released?: (...) | (...) | (...);
                          releaseDate?: (...) | (...);
                          self?: (...) | (...);
                          startDate?: (...) | (...);
                          userReleaseDate?: (...) | (...);
                          userStartDate?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  };
                  role?: {
                      actors?: {
                          actorGroup?: (...)
                          | (...);
                          actorUser?: (...) | (...);
                          avatarUrl?: (...) | (...);
                          displayName?: (...) | (...);
                          id?: (...) | (...);
                          type?: (...) | (...) | (...) | (...);
                          [key: string]: unknown;
                      }[];
                      admin?: boolean;
                      currentUserRole?: boolean;
                      default?: boolean;
                      description?: string;
                      id?: number;
                      name?: string;
                      roleConfigurable?: boolean;
                      scope?: {
                          project?: {
                              avatarUrls?: ...;
                              id?: ...;
                              key?: ...;
                              name?: ...;
                              projectCategory?: ...;
                              projectTypeKey?: ...;
                              self?: ...;
                              simplified?: ...;
                              [key: ...]: ...;
                          };
                          type?: (...) & (...)
                          | "PROJECT"
                          | "TEMPLATE";
                          [key: string]: unknown;
                      };
                      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"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      displayName?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  [key: string]: unknown;
              }[];
              favourite?: boolean;
              favouritedCount?: number;
              id?: string;
              isWritable?: boolean;
              jql?: string;
              name: string;
              owner?: {
                  accountId?: string;
                  accountType?: "unknown"
                  | string & {}
                  | "atlassian"
                  | "app"
                  | "customer";
                  active?: boolean;
                  applicationRoles?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          defaultGroups?: (...)[];
                          defaultGroupsDetails?: (...)[];
                          defined?: boolean;
                          groupDetails?: (...)[];
                          groups?: (...)[];
                          hasUnlimitedSeats?: boolean;
                          key?: string;
                          name?: string;
                          numberOfSeats?: number;
                          platform?: boolean;
                          remainingSeats?: number;
                          selectedByDefault?: boolean;
                          userCount?: number;
                          userCountDescription?: string;
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  appType?: string;
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  displayName?: string;
                  emailAddress?: string;
                  expand?: string;
                  groups?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          groupId?: string | null;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  guest?: boolean;
                  locale?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              searchUrl?: string;
              self?: string;
              sharedUsers?: {
                  "end-index"?: number;
                  items?: {
                      accountId?: string;
                      accountType?: "unknown"
                      | string & {}
                      | "atlassian"
                      | "app"
                      | "customer";
                      active?: boolean;
                      applicationRoles?: {
                          callback?: { [key: ...]: ... };
                          items?: (...)[];
                          "max-results"?: number;
                          pagingCallback?: { [key: ...]: ... };
                          size?: number;
                          [key: string]: unknown;
                      };
                      appType?: string;
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      displayName?: string;
                      emailAddress?: string;
                      expand?: string;
                      groups?: {
                          callback?: { [key: ...]: ... };
                          items?: (...)[];
                          "max-results"?: number;
                          pagingCallback?: { [key: ...]: ... };
                          size?: number;
                          [key: string]: unknown;
                      };
                      guest?: boolean;
                      locale?: string;
                      self?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  }[];
                  "max-results"?: number;
                  size?: number;
                  "start-index"?: number;
                  [key: string]: unknown;
              };
              sharePermissions?: {
                  group?: {
                      groupId?: string
                      | null;
                      name?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  id?: number;
                  project?: {
                      archived?: boolean;
                      archivedBy?: {
                          accountId?: string;
                          accountType?: | "unknown"
                          | (...) & (...)
                          | "atlassian"
                          | "app"
                          | "customer";
                          active?: boolean;
                          applicationRoles?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          appType?: string;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          emailAddress?: string;
                          expand?: string;
                          groups?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          guest?: boolean;
                          locale?: string;
                          self?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      archivedDate?: Date;
                      assigneeType?: string & {}
                      | "PROJECT_LEAD"
                      | "UNASSIGNED";
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      components?: {
                          ari?: (...)
                          | (...);
                          assignee?: (...) | (...);
                          assigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
                          description?: (...) | (...);
                          id?: (...) | (...);
                          isAssigneeTypeValid?: (...) | (...) | (...);
                          lead?: (...) | (...);
                          leadAccountId?: (...) | (...);
                          metadata?: (...) | (...);
                          name?: (...) | (...);
                          project?: (...) | (...);
                          projectId?: (...) | (...);
                          realAssignee?: (...) | (...);
                          realAssigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
                          self?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      deleted?: boolean;
                      deletedBy?: {
                          accountId?: string;
                          accountType?: | "unknown"
                          | (...) & (...)
                          | "atlassian"
                          | "app"
                          | "customer";
                          active?: boolean;
                          applicationRoles?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          appType?: string;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          emailAddress?: string;
                          expand?: string;
                          groups?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          guest?: boolean;
                          locale?: string;
                          self?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      deletedDate?: Date;
                      description?: string;
                      email?: string;
                      entityId?: string;
                      expand?: string;
                      favourite?: boolean;
                      id?: string;
                      insight?: {
                          lastIssueUpdateTime?: Date;
                          totalIssueCount?: number;
                          [key: string]: unknown;
                      };
                      isPrivate?: boolean;
                      issueTypeHierarchy?: { levels?: (...)[]; [key: string]: unknown };
                      issueTypes?: {
                          avatarId?: (...) | (...);
                          description?: (...) | (...);
                          entityId?: (...) | (...);
                          hierarchyLevel?: (...) | (...);
                          iconUrl?: (...) | (...);
                          id?: (...) | (...);
                          name?: (...) | (...);
                          scope?: (...) | (...);
                          self?: (...) | (...);
                          subtask?: (...) | (...) | (...);
                          untranslatedName?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      key?: string;
                      landingPageInfo?: {
                          attributes?: Record<(...), (...)>;
                          boardId?: number;
                          boardName?: string;
                          projectKey?: string;
                          projectType?: string;
                          queueCategory?: string;
                          queueId?: number;
                          queueName?: string;
                          simpleBoard?: boolean;
                          simplified?: boolean;
                          url?: string;
                          [key: string]: unknown;
                      };
                      lead?: {
                          accountId?: string;
                          accountType?: | "unknown"
                          | (...) & (...)
                          | "atlassian"
                          | "app"
                          | "customer";
                          active?: boolean;
                          applicationRoles?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          appType?: string;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          emailAddress?: string;
                          expand?: string;
                          groups?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          guest?: boolean;
                          locale?: string;
                          self?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      name?: string;
                      permissions?: { canEdit?: boolean; [key: string]: unknown };
                      projectCategory?: {
                          description?: string;
                          id?: string;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      projectTypeKey?: | string & {}
                      | "software"
                      | "service_desk"
                      | "business"
                      | "product_discovery"
                      | "customer_service";
                      properties?: Record<string, any>;
                      retentionTillDate?: Date;
                      roles?: Record<string, any>;
                      self?: string;
                      simplified?: boolean;
                      style?: "classic" | string & {} | "next-gen";
                      url?: string;
                      uuid?: string;
                      versions?: {
                          approvers?: (...) | (...);
                          archived?: (...) | (...) | (...);
                          description?: (...) | (...);
                          driver?: (...) | (...);
                          expand?: (...) | (...);
                          id?: (...) | (...);
                          issuesStatusForFixVersion?: (...) | (...);
                          moveUnfixedIssuesTo?: (...) | (...);
                          name?: (...) | (...);
                          operations?: (...) | (...);
                          overdue?: (...) | (...) | (...);
                          projectId?: (...) | (...);
                          released?: (...) | (...) | (...);
                          releaseDate?: (...) | (...);
                          self?: (...) | (...);
                          startDate?: (...) | (...);
                          userReleaseDate?: (...) | (...);
                          userStartDate?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  };
                  role?: {
                      actors?: {
                          actorGroup?: (...)
                          | (...);
                          actorUser?: (...) | (...);
                          avatarUrl?: (...) | (...);
                          displayName?: (...) | (...);
                          id?: (...) | (...);
                          type?: (...) | (...) | (...) | (...);
                          [key: string]: unknown;
                      }[];
                      admin?: boolean;
                      currentUserRole?: boolean;
                      default?: boolean;
                      description?: string;
                      id?: number;
                      name?: string;
                      roleConfigurable?: boolean;
                      scope?: {
                          project?: {
                              avatarUrls?: ...;
                              id?: ...;
                              key?: ...;
                              name?: ...;
                              projectCategory?: ...;
                              projectTypeKey?: ...;
                              self?: ...;
                              simplified?: ...;
                              [key: ...]: ...;
                          };
                          type?: (...) & (...)
                          | "PROJECT"
                          | "TEMPLATE";
                          [key: string]: unknown;
                      };
                      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"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      displayName?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  [key: string]: unknown;
              }[];
              subscriptions?: {
                  "end-index"?: number;
                  items?: {
                      group?: {
                          groupId?: string
                          | null;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      id?: number;
                      user?: {
                          accountId?: string;
                          accountType?: | "unknown"
                          | (...) & (...)
                          | "atlassian"
                          | "app"
                          | "customer";
                          active?: boolean;
                          applicationRoles?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          appType?: string;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          emailAddress?: string;
                          expand?: string;
                          groups?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          guest?: boolean;
                          locale?: string;
                          self?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  }[];
                  "max-results"?: number;
                  size?: number;
                  "start-index"?: number;
                  [key: string]: unknown;
              };
              viewUrl?: string;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility