Function: createFilter()

function createFilter(
   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:25

Creates a new filter, and returns newly created filter. Currently sets permissions just using the users default sharing permissions

Parameters

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