jira.js
    Preparing search index...

    Function editFilter

    • Updates an existing filter, and returns its new value. The following properties of a filter can be updated: 'jql', 'name', 'description'. Additionally, administrators can also update the 'owner' field. To get, set or unset 'favourite', use rest/api/1.0/filters/{id}/favourite with GET, PUT and DELETE methods instead.

      Parameters

      • client: Client
      • parameters: {
            body?: {
                description?: string;
                editable?: boolean;
                favourite?: boolean;
                id?: string;
                jql?: string;
                name?: string;
                owner?: {
                    active?: boolean;
                    applicationRoles?: {
                        callback?: { [key: string]: unknown };
                        maxResults?: number;
                        pagingCallback?: { [key: string]: unknown };
                        size?: number;
                        [key: string]: unknown;
                    };
                    avatarUrls?: Record<string, string>;
                    deleted?: boolean;
                    displayName?: string;
                    emailAddress?: string;
                    expand?: string;
                    groups?: {
                        callback?: { [key: string]: unknown };
                        maxResults?: number;
                        pagingCallback?: { [key: string]: unknown };
                        size?: number;
                        [key: string]: unknown;
                    };
                    key?: string;
                    lastLoginTime?: string;
                    locale?: string;
                    name?: string;
                    self?: string;
                    timeZone?: string;
                    [key: string]: unknown;
                };
                searchUrl?: string;
                self?: string;
                sharedUsers?: {
                    backingListSize?: number;
                    callback?: { [key: string]: unknown };
                    items?: {
                        active?: boolean;
                        applicationRoles?: {
                            callback?: (...) | (...);
                            maxResults?: (...) | (...);
                            pagingCallback?: (...) | (...);
                            size?: (...) | (...);
                            [key: string]: unknown;
                        };
                        avatarUrls?: Record<string, string>;
                        deleted?: boolean;
                        displayName?: string;
                        emailAddress?: string;
                        expand?: string;
                        groups?: {
                            callback?: (...) | (...);
                            maxResults?: (...) | (...);
                            pagingCallback?: (...) | (...);
                            size?: (...) | (...);
                            [key: string]: unknown;
                        };
                        key?: string;
                        lastLoginTime?: string;
                        locale?: string;
                        name?: string;
                        self?: string;
                        timeZone?: string;
                        [key: string]: unknown;
                    }[];
                    maxResults?: number;
                    pagingCallback?: { [key: string]: unknown };
                    size?: number;
                    [key: string]: unknown;
                };
                sharePermissions?: {
                    edit?: boolean;
                    group?: { name?: string; self?: string; [key: string]: unknown };
                    id?: number;
                    project?: {
                        archived?: boolean;
                        avatarUrls?: Record<string, string>;
                        description?: string;
                        id?: string;
                        key?: string;
                        name?: string;
                        self?: string;
                        [key: string]: unknown;
                    };
                    role?: {
                        actors?: { avatarUrl?: ...; name?: ...; [key: ...]: ... }[];
                        description?: string;
                        id?: number;
                        name?: string;
                        self?: string;
                        [key: string]: unknown;
                    };
                    type?: string;
                    user?: {
                        active?: boolean;
                        applicationRoles?: {
                            callback?: (...)
                            | (...);
                            maxResults?: (...) | (...);
                            pagingCallback?: (...) | (...);
                            size?: (...) | (...);
                            [key: string]: unknown;
                        };
                        avatarUrls?: Record<string, string>;
                        deleted?: boolean;
                        displayName?: string;
                        emailAddress?: string;
                        expand?: string;
                        groups?: {
                            callback?: (...) | (...);
                            maxResults?: (...) | (...);
                            pagingCallback?: (...) | (...);
                            size?: (...) | (...);
                            [key: string]: unknown;
                        };
                        key?: string;
                        lastLoginTime?: string;
                        locale?: string;
                        name?: string;
                        self?: string;
                        timeZone?: string;
                        [key: string]: unknown;
                    };
                    view?: boolean;
                    [key: string]: unknown;
                }[];
                viewUrl?: string;
                [key: string]: unknown;
            };
            expand?: string
            | string[];
            id: string;
        }
        • Optionalbody?: {
              description?: string;
              editable?: boolean;
              favourite?: boolean;
              id?: string;
              jql?: string;
              name?: string;
              owner?: {
                  active?: boolean;
                  applicationRoles?: {
                      callback?: { [key: string]: unknown };
                      maxResults?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  avatarUrls?: Record<string, string>;
                  deleted?: boolean;
                  displayName?: string;
                  emailAddress?: string;
                  expand?: string;
                  groups?: {
                      callback?: { [key: string]: unknown };
                      maxResults?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  key?: string;
                  lastLoginTime?: string;
                  locale?: string;
                  name?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              searchUrl?: string;
              self?: string;
              sharedUsers?: {
                  backingListSize?: number;
                  callback?: { [key: string]: unknown };
                  items?: {
                      active?: boolean;
                      applicationRoles?: {
                          callback?: (...) | (...);
                          maxResults?: (...) | (...);
                          pagingCallback?: (...) | (...);
                          size?: (...) | (...);
                          [key: string]: unknown;
                      };
                      avatarUrls?: Record<string, string>;
                      deleted?: boolean;
                      displayName?: string;
                      emailAddress?: string;
                      expand?: string;
                      groups?: {
                          callback?: (...) | (...);
                          maxResults?: (...) | (...);
                          pagingCallback?: (...) | (...);
                          size?: (...) | (...);
                          [key: string]: unknown;
                      };
                      key?: string;
                      lastLoginTime?: string;
                      locale?: string;
                      name?: string;
                      self?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  }[];
                  maxResults?: number;
                  pagingCallback?: { [key: string]: unknown };
                  size?: number;
                  [key: string]: unknown;
              };
              sharePermissions?: {
                  edit?: boolean;
                  group?: { name?: string; self?: string; [key: string]: unknown };
                  id?: number;
                  project?: {
                      archived?: boolean;
                      avatarUrls?: Record<string, string>;
                      description?: string;
                      id?: string;
                      key?: string;
                      name?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  role?: {
                      actors?: { avatarUrl?: ...; name?: ...; [key: ...]: ... }[];
                      description?: string;
                      id?: number;
                      name?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  type?: string;
                  user?: {
                      active?: boolean;
                      applicationRoles?: {
                          callback?: (...)
                          | (...);
                          maxResults?: (...) | (...);
                          pagingCallback?: (...) | (...);
                          size?: (...) | (...);
                          [key: string]: unknown;
                      };
                      avatarUrls?: Record<string, string>;
                      deleted?: boolean;
                      displayName?: string;
                      emailAddress?: string;
                      expand?: string;
                      groups?: {
                          callback?: (...) | (...);
                          maxResults?: (...) | (...);
                          pagingCallback?: (...) | (...);
                          size?: (...) | (...);
                          [key: string]: unknown;
                      };
                      key?: string;
                      lastLoginTime?: string;
                      locale?: string;
                      name?: string;
                      self?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  };
                  view?: boolean;
                  [key: string]: unknown;
              }[];
              viewUrl?: string;
              [key: string]: unknown;
          }
        • Optionalexpand?: string | string[]
        • id: string

          The filter id.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              description?: string;
              editable?: boolean;
              favourite?: boolean;
              id?: string;
              jql?: string;
              name?: string;
              owner?: {
                  active?: boolean;
                  applicationRoles?: {
                      callback?: { [key: string]: unknown };
                      maxResults?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  avatarUrls?: Record<string, string>;
                  deleted?: boolean;
                  displayName?: string;
                  emailAddress?: string;
                  expand?: string;
                  groups?: {
                      callback?: { [key: string]: unknown };
                      maxResults?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  key?: string;
                  lastLoginTime?: string;
                  locale?: string;
                  name?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              searchUrl?: string;
              self?: string;
              sharedUsers?: {
                  backingListSize?: number;
                  callback?: { [key: string]: unknown };
                  items?: {
                      active?: boolean;
                      applicationRoles?: {
                          callback?: { [key: ...]: ... };
                          maxResults?: number;
                          pagingCallback?: { [key: ...]: ... };
                          size?: number;
                          [key: string]: unknown;
                      };
                      avatarUrls?: Record<string, string>;
                      deleted?: boolean;
                      displayName?: string;
                      emailAddress?: string;
                      expand?: string;
                      groups?: {
                          callback?: { [key: ...]: ... };
                          maxResults?: number;
                          pagingCallback?: { [key: ...]: ... };
                          size?: number;
                          [key: string]: unknown;
                      };
                      key?: string;
                      lastLoginTime?: string;
                      locale?: string;
                      name?: string;
                      self?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  }[];
                  maxResults?: number;
                  pagingCallback?: { [key: string]: unknown };
                  size?: number;
                  [key: string]: unknown;
              };
              sharePermissions?: {
                  edit?: boolean;
                  group?: { name?: string; self?: string; [key: string]: unknown };
                  id?: number;
                  project?: {
                      archived?: boolean;
                      avatarUrls?: Record<string, string>;
                      description?: string;
                      id?: string;
                      key?: string;
                      name?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  role?: {
                      actors?: {
                          avatarUrl?: (...)
                          | (...);
                          name?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      description?: string;
                      id?: number;
                      name?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  type?: string;
                  user?: {
                      active?: boolean;
                      applicationRoles?: {
                          callback?: { [key: ...]: ... };
                          maxResults?: number;
                          pagingCallback?: { [key: ...]: ... };
                          size?: number;
                          [key: string]: unknown;
                      };
                      avatarUrls?: Record<string, string>;
                      deleted?: boolean;
                      displayName?: string;
                      emailAddress?: string;
                      expand?: string;
                      groups?: {
                          callback?: { [key: ...]: ... };
                          maxResults?: number;
                          pagingCallback?: { [key: ...]: ... };
                          size?: number;
                          [key: string]: unknown;
                      };
                      key?: string;
                      lastLoginTime?: string;
                      locale?: string;
                      name?: string;
                      self?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  };
                  view?: boolean;
                  [key: string]: unknown;
              }[];
              viewUrl?: string;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility