Function: editFilter()

function editFilter(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  description?: string;
  editable?: boolean;
  favourite?: boolean;
  id?: string;
  jql?: string;
  name?: string;
  owner?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: string]: unknown;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: string]: unknown;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: string]: unknown;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: string]: unknown;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  searchUrl?: string;
  self?: string;
  sharedUsers?: {
   [key: string]: unknown;
     backingListSize?: number;
     callback?: {
      [key: string]: unknown;
     };
     items?: object[];
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  sharePermissions?: object[];
  viewUrl?: string;
}>;

Defined in: src/server/api/filters.ts:130

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

Parameter	Type	Description
client	Client	-
parameters	{ body?: { description?: string; editable?: boolean; favourite?: boolean; id?: string; jql?: string; name?: string; owner?: { active?: boolean; applicationRoles?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { backingListSize?: number; callback?: Record<string, never>; items?: object[]; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; sharePermissions?: object[]; viewUrl?: string; }; expand?: string | string[]; id: string; }	-
parameters.body?	{ description?: string; editable?: boolean; favourite?: boolean; id?: string; jql?: string; name?: string; owner?: { active?: boolean; applicationRoles?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { backingListSize?: number; callback?: Record<string, never>; items?: object[]; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; sharePermissions?: object[]; viewUrl?: string; }	-
parameters.body.description?	string	-
parameters.body.editable?	boolean	-
parameters.body.favourite?	boolean	-
parameters.body.id?	string	-
parameters.body.jql?	string	-
parameters.body.name?	string	-
parameters.body.owner?	{ active?: boolean; applicationRoles?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }	-
parameters.body.owner.active?	boolean	-
parameters.body.owner.applicationRoles?	{ callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }	-
parameters.body.owner.applicationRoles.callback?	Record<string, never>	-
parameters.body.owner.applicationRoles.maxResults?	number	-
parameters.body.owner.applicationRoles.pagingCallback?	Record<string, never>	-
parameters.body.owner.applicationRoles.size?	number	-
parameters.body.owner.avatarUrls?	Record<string, string>	-
parameters.body.owner.deleted?	boolean	-
parameters.body.owner.displayName?	string	-
parameters.body.owner.emailAddress?	string	-
parameters.body.owner.expand?	string	-
parameters.body.owner.groups?	{ callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }	-
parameters.body.owner.groups.callback?	Record<string, never>	-
parameters.body.owner.groups.maxResults?	number	-
parameters.body.owner.groups.pagingCallback?	Record<string, never>	-
parameters.body.owner.groups.size?	number	-
parameters.body.owner.key?	string	-
parameters.body.owner.lastLoginTime?	string	-
parameters.body.owner.locale?	string	-
parameters.body.owner.name?	string	-
parameters.body.owner.self?	string	-
parameters.body.owner.timeZone?	string	-
parameters.body.searchUrl?	string	-
parameters.body.self?	string	-
parameters.body.sharedUsers?	{ backingListSize?: number; callback?: Record<string, never>; items?: object[]; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }	-
parameters.body.sharedUsers.backingListSize?	number	-
parameters.body.sharedUsers.callback?	Record<string, never>	-
parameters.body.sharedUsers.items?	object[]	-
parameters.body.sharedUsers.maxResults?	number	-
parameters.body.sharedUsers.pagingCallback?	Record<string, never>	-
parameters.body.sharedUsers.size?	number	-
parameters.body.sharePermissions?	object[]	-
parameters.body.viewUrl?	string	-
parameters.expand?	string | string[]	-
parameters.id?	string	The filter id.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; description?: string; editable?: boolean; favourite?: boolean; id?: string; jql?: string; name?: string; owner?: { [key: string]: unknown; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { [key: string]: unknown; backingListSize?: number; callback?: { [key: string]: unknown; }; items?: object[]; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; sharePermissions?: object[]; viewUrl?: string; }>