Class FiltersService

This resource represents filters. Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter and set favorite filters.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters

Hierarchy

CommonHttpService
- FiltersService

Index

Constructors

constructor

Methods

changeFilterOwner createFilter deleteFavouriteForFilter deleteFilter getColumns getFavouriteFilters getFilter getFiltersPaginated getMyFilters resetColumns setColumns setFavouriteForFilter updateFilter initialize

Constructors

constructor

new FiltersService(getClientInstance): FiltersService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns FiltersService
Inherited from CommonHttpService.constructor

Methods

changeFilterOwner

changeFilterOwner(params): Promise<void>
Changes the owner of the filter.

Permissions required: Permission to access Jira. However, the user must own the filter or have the Administer Jira global permission.
Parameters
- params: {
  changeFilterOwner: ChangeFilterOwner;
  id: number;
  }
  - changeFilterOwner: ChangeFilterOwner
    The account ID of the new owner of the filter.
    
    Example
  - id: number
    The ID of the filter to update.
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/filter/{id}/owner @scopes-beta read:filter:jira, write:filter:jira @scopes-current write:jira-work

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-owner-put

createFilter

createFilter(params): Promise<Filter>
Creates a filter. The filter is shared according to the default share scope. The filter is not selected as a favorite.

Permissions required: Permission to access Jira.
Parameters
- params: {
      expand?: string;
      filter: Filter;
      overrideSharePermissions?: boolean;
  }
  - Optionalexpand?: string
    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].
  - filter: Filter
    The filter to create.
    
    Example
  - OptionaloverrideSharePermissions?: boolean
    EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with Administer Jira global permission.
Returns Promise<Filter>
Returned if the request is successful.

example:
```
{
  "approximateLastUsed": null,
  "description": "Lists all open bugs",
  "favourite": true,
  "favouritedCount": 0,
  "id": "10000",
  "jql": "type = Bug and resolution is empty",
  "name": "All Open Bugs",
  "owner": {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": false,
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
  },
  "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
  "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
  "sharePermissions": [],
  "subscriptions": {
    "end-index": 0,
    "items": [],
    "max-results": 0,
    "size": 0,
    "start-index": 0
  },
  "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
}
```
Path
POST /rest/api/3/filter @scopes-current write:jira-work @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, write:filter:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira, read:project-category:jira, read:project-version:jira, read:project.component:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-post

deleteFavouriteForFilter

deleteFavouriteForFilter(params): Promise<Filter>
Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.

Permissions required: Permission to access Jira.
Parameters
- params: {
  expand?: string;
  id: number;
  }
  - Optionalexpand?: string
    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.
Returns Promise<Filter>
Returned if the request is successful.

example:
```
{
  "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
  "description": "Lists all open bugs",
  "favourite": true,
  "favouritedCount": 0,
  "id": "10000",
  "jql": "type = Bug and resolution is empty",
  "name": "All Open Bugs",
  "owner": {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": false,
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
  },
  "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
  "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
  "sharePermissions": [],
  "subscriptions": {
    "end-index": 0,
    "items": [],
    "max-results": 0,
    "size": 0,
    "start-index": 0
  },
  "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
}
```
Path
DELETE /rest/api/3/filter/{id}/favourite @scopes-current write:jira-work @scopes-beta write:filter:jira, read:application-role:jira, read:avatar:jira, read:filter:jira, read:group:jira, read:issue-type-hierarchy:jira, read:issue-type:jira, read:project-category:jira, read:project-role:jira, read:project-version:jira, read:project.component:jira, read:project:jira, read:user:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-favourite-delete

deleteFilter

deleteFilter(params): Promise<void>
Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the filter to delete.
Returns Promise<void>
Path
DELETE /rest/api/3/filter/{id} @scopes-current write:jira-work @scopes-beta delete:filter:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-delete

getColumns

getColumns(params): Promise<ColumnItem[]>
Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in List View with the Columns set to Filter.

This operation can be accessed anonymously.

Permissions required: None, however, column details are only returned for:
- 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
- params: {
  id: number;
  }
  - id: number
    The ID of the filter.
Returns Promise<ColumnItem[]>
Returned if the request is successful.

example:
```
[
  {
    "label": "Key",
    "value": "issuekey"
  },
  {
    "label": "Summary",
    "value": "summary"
  }
]
```
Path
GET /rest/api/3/filter/{id}/columns @scopes-current read:jira-work @scopes-beta read:filter.column:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-get

getFavouriteFilters

getFavouriteFilters(params?): Promise<Filter[]>

Returns the visible favorite filters of the user.

This operation can be accessed anonymously.

Permissions required: A favorite filter is only visible to the user where the filter is:

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

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

Parameters

params: {
expand?: string;
} = {}
- Optionalexpand?: string
  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].

Returns Promise<Filter[]>

Returned if the request is successful.

example:

[
  {
    "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
    "description": "Lists all open bugs",
    "favourite": true,
    "favouritedCount": 0,
    "id": "10000",
    "jql": "type = Bug and resolution is empty",
    "name": "All Open Bugs",
    "owner": {
      "accountId": "5b10a2844c20165700ede21g",
      "accountType": "atlassian",
      "active": false,
      "avatarUrls": {
        "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
        "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
        "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
        "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      },
      "displayName": "Mia Krystof",
      "key": "",
      "name": "",
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
    },
    "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
    "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
    "sharePermissions": [],
    "subscriptions": {
      "end-index": 0,
      "items": [],
      "max-results": 0,
      "size": 0,
      "start-index": 0
    },
    "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
  },
  {
    "approximateLastUsed": null,
    "description": "Issues assigned to me",
    "favourite": true,
    "favouritedCount": 0,
    "id": "10010",
    "jql": "assignee = currentUser() and resolution is empty",
    "name": "My issues",
    "owner": {
      "accountId": "5b10a2844c20165700ede21g",
      "accountType": "atlassian",
      "active": false,
      "avatarUrls": {
        "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
        "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
        "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
        "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      },
      "displayName": "Mia Krystof",
      "key": "",
      "name": "",
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
    },
    "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
    "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
    "sharePermissions": [
      {
        "id": 10000,
        "type": "global"
      },
      {
        "id": 10010,
        "project": {
          "avatarUrls": {
            "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
            "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
            "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
            "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          },
          "id": "10000",
          "insight": {
            "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
            "totalIssueCount": 100
          },
          "key": "EX",
          "name": "Example",
          "projectCategory": {
            "description": "First Project Category",
            "id": "10000",
            "name": "FIRST",
            "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          },
          "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          "simplified": false,
          "style": "classic"
        },
        "type": "project"
      }
    ],
    "subscriptions": {
      "end-index": 0,
      "items": [],
      "max-results": 0,
      "size": 0,
      "start-index": 0
    },
    "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
  }
]

Path

GET /rest/api/3/filter/favourite @scopes-current read:jira-work @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-favourite-get

getFilter

getFilter(params): Promise<Filter>
Returns a filter.

This operation can be accessed anonymously.

Permissions required: None, however, the filter is only returned where it is:
- owned by the user.
- shared with a group that the user is a member of.
- shared with a private project that the user has Browse projects project permission for.
- shared with a public project.
- shared with the public.
Parameters
- params: {
      expand?: string;
      id: number;
      overrideSharePermissions?: boolean;
  }
  - Optionalexpand?: string
    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 to return.
  - OptionaloverrideSharePermissions?: boolean
    EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with Administer Jira global permission.
Returns Promise<Filter>
Returned if the request is successful.

example:
```
{
  "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
  "description": "Lists all open bugs",
  "favourite": true,
  "favouritedCount": 0,
  "id": "10000",
  "jql": "type = Bug and resolution is empty",
  "name": "All Open Bugs",
  "owner": {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": false,
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
  },
  "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
  "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
  "sharePermissions": [],
  "subscriptions": {
    "end-index": 0,
    "items": [],
    "max-results": 0,
    "size": 0,
    "start-index": 0
  },
  "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
}
```
Path
GET /rest/api/3/filter/{id} @scopes-current read:jira-work @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-get

getFiltersPaginated

getFiltersPaginated(params?): Promise<PageBeanFilterDetails>

Returns a paginated list of filters. Use this operation to get:

specific filters, by defining id only.
filters that match all of the specified attributes. For example, all filters for a user with a particular word in their name. When multiple attributes are specified only filters matching all attributes are returned.

This operation can be accessed anonymously.

Permissions required: None, however, only the following filters that match the query parameters are returned:

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

params: {
    accountId?: string;
    expand?: string;
    filterName?: string;
    groupId?: string;
    groupname?: string;
    id?: number[];
    isSubstringMatch?: boolean;
    maxResults?: number;
    orderBy?:
        | "id"
        | "name"
        | "description"
        | "owner"
        | "-description"
        | "+description"
        | "-id"
        | "+id"
        | "-name"
        | "+name"
        | "-owner"
        | "+owner"
        | "favourite_count"
        | "-favourite_count"
        | "+favourite_count"
        | "is_favourite"
        | "-is_favourite"
        | "+is_favourite"
        | "is_shared"
        | "-is_shared"
        | "+is_shared";
    overrideSharePermissions?: boolean;
    owner?: string;
    projectId?: number;
    startAt?: number;
} = {}
- OptionalaccountId?: string
  User account ID used to return filters with the matching owner.accountId. This parameter cannot be used with owner.
- Optionalexpand?: string
  Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:
  - description Returns the description of the filter.
  - favourite Returns an indicator of whether the user has set the filter as a favorite.
  - favouritedCount Returns a count of how many users have set this filter as a favorite.
  - jql Returns the JQL query that the filter uses.
  - owner Returns the owner of the filter.
  - searchUrl Returns a URL to perform the filter's JQL query.
  - sharePermissions Returns the share permissions defined for the filter.
  - editPermissions Returns the edit permissions defined for the filter.
  - isWritable Returns whether the current user has permission to edit the filter.
  - approximateLastUsed [Experimental] Returns the approximate date and time when the filter was last evaluated.
  - subscriptions Returns the users that are subscribed to the filter.
  - viewUrl Returns a URL to view the filter.
- OptionalfilterName?: string
  String used to perform a case-insensitive partial match with name.
- OptionalgroupId?: string
  Group ID used to returns filters that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter.
- Optionalgroupname?: string
  As a group's name can change, use of groupId is recommended to identify a group. Group name used to returns filters that are shared with a group that matches sharePermissions.group.groupname. This parameter cannot be used with the groupId parameter.
- Optionalid?: number[]
  The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Do not exceed 200 filter IDs.
- OptionalisSubstringMatch?: boolean
  When true this will perform a case-insensitive substring match for the provided filterName. When false the filter name will be searched using full text search syntax.
- OptionalmaxResults?: number
  The maximum number of items to return per page.
- OptionalorderBy?:
      | "id"
      | "name"
      | "description"
      | "owner"
      | "-description"
      | "+description"
      | "-id"
      | "+id"
      | "-name"
      | "+name"
      | "-owner"
      | "+owner"
      | "favourite_count"
      | "-favourite_count"
      | "+favourite_count"
      | "is_favourite"
      | "-is_favourite"
      | "+is_favourite"
      | "is_shared"
      | "-is_shared"
      | "+is_shared"
  Order the results by a field:
  - description Sorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use.
  - favourite_count Sorts by the count of how many users have this filter as a favorite.
  - is_favourite Sorts by whether the filter is marked as a favorite.
  - id Sorts by filter ID.
  - name Sorts by filter name.
  - owner Sorts by the ID of the filter owner.
  - is_shared Sorts by whether the filter is shared.
- OptionaloverrideSharePermissions?: boolean
  EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with Administer Jira global permission.
- Optionalowner?: string
  This parameter is deprecated because of privacy changes. Use accountId instead. See the migration guide for details. User name used to return filters with the matching owner.name. This parameter cannot be used with accountId.
- OptionalprojectId?: number
  Project ID used to returns filters that are shared with a project that matches sharePermissions.project.id.
- OptionalstartAt?: number
  The index of the first item to return in a page of results (page offset).

Returns Promise<PageBeanFilterDetails>

Returned if the request is successful.

example:

{
  "isLast": true,
  "maxResults": 100,
  "self": "https://your-domain.atlassian.net/rest/api/3/filter/search?accountId=&maxResults=50&filterName=&orderBy=name&startAt=0&expand=description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,subscriptions,approximateLastUsed",
  "startAt": 0,
  "total": 2,
  "values": [
    {
      "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
      "description": "Lists all open bugs",
      "editPermissions": [],
      "expand": "description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
      "favourite": false,
      "favouritedCount": 0,
      "id": "10000",
      "jql": "type = Bug and resolution is empty",
      "name": "All Open Bugs",
      "owner": {
        "accountId": "5b10a2844c20165700ede21g",
        "accountType": "atlassian",
        "active": false,
        "avatarUrls": {
          "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
          "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
          "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
          "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
        },
        "displayName": "Mia Krystof",
        "key": "",
        "name": "",
        "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      },
      "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
      "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
      "sharePermissions": [],
      "subscriptions": [],
      "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
    },
    {
      "approximateLastUsed": null,
      "description": "Issues assigned to me",
      "editPermissions": [
        {
          "id": 10010,
          "project": {
            "avatarUrls": {
              "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002",
              "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002",
              "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002",
              "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002"
            },
            "deleted": true,
            "deletedBy": {
              "accountId": "5b10a2844c20165700ede21g",
              "accountType": "atlassian",
              "active": false,
              "avatarUrls": {
                "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
                "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
                "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
                "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
              },
              "displayName": "Mia Krystof",
              "key": "",
              "name": "",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "deletedDate": "2022-11-11T13:35:29.000+0000",
            "id": "10002",
            "insight": {
              "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
              "totalIssueCount": 100
            },
            "key": "MKY",
            "name": "Example",
            "projectCategory": {
              "description": "First Project Category",
              "id": "10000",
              "name": "FIRST",
              "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
            },
            "retentionTillDate": "2023-01-10T13:35:29.000+0000",
            "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY",
            "simplified": false,
            "style": "classic"
          },
          "role": {
            "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
            "name": "Developers",
            "id": 10360,
            "description": "A project role that represents developers in a project",
            "actors": [
              {
                "actorGroup": {
                  "name": "jira-developers",
                  "displayName": "jira-developers",
                  "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
                },
                "displayName": "jira-developers",
                "id": 10240,
                "name": "jira-developers",
                "type": "atlassian-group-role-actor"
              },
              {
                "actorUser": {
                  "accountId": "5b10a2844c20165700ede21g"
                },
                "displayName": "Mia Krystof",
                "id": 10241,
                "type": "atlassian-user-role-actor"
              }
            ],
            "scope": {
              "project": {
                "id": "10000",
                "key": "KEY",
                "name": "Next Gen Project"
              },
              "type": "PROJECT"
            }
          },
          "type": "project"
        },
        {
          "group": {
            "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
            "name": "jira-administrators",
            "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
          },
          "id": 10010,
          "type": "group"
        }
      ],
      "expand": "description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
      "favourite": true,
      "favouritedCount": 123,
      "id": "10010",
      "jql": "assignee = currentUser() and resolution is empty",
      "name": "My issues",
      "owner": {
        "accountId": "5b10a2844c20165700ede21g",
        "accountType": "atlassian",
        "active": false,
        "avatarUrls": {
          "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
          "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
          "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
          "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
        },
        "displayName": "Mia Krystof",
        "key": "",
        "name": "",
        "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      },
      "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
      "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
      "sharePermissions": [
        {
          "id": 10000,
          "type": "global"
        },
        {
          "id": 10010,
          "project": {
            "avatarUrls": {
              "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
              "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
              "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
              "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
            },
            "id": "10000",
            "insight": {
              "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
              "totalIssueCount": 100
            },
            "key": "EX",
            "name": "Example",
            "projectCategory": {
              "description": "First Project Category",
              "id": "10000",
              "name": "FIRST",
              "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
            },
            "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
            "simplified": false,
            "style": "classic"
          },
          "type": "project"
        }
      ],
      "subscriptions": [
        {
          "id": 1,
          "user": {
            "accountId": "5b10a2844c20165700ede21g",
            "accountType": "atlassian",
            "active": true,
            "applicationRoles": {
              "items": [],
              "size": 1
            },
            "avatarUrls": {
              "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
              "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
              "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
              "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
            },
            "displayName": "Mia Krystof",
            "emailAddress": "mia@example.com",
            "groups": {
              "items": [],
              "size": 3
            },
            "key": "",
            "name": "",
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
            "timeZone": "Australia/Sydney"
          }
        }
      ],
      "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
    }
  ]
}

Path

GET /rest/api/3/filter/search @scopes-current read:jira-work @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-search-get

getMyFilters

getMyFilters(params?): Promise<Filter[]>

Returns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

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

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

Parameters

params: {
expand?: string;
includeFavourites?: boolean;
} = {}
- Optionalexpand?: string
  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].
- OptionalincludeFavourites?: boolean
  Include the user's favorite filters in the response.

Returns Promise<Filter[]>

Returned if the request is successful.

example:

[
  {
    "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
    "description": "Lists all open bugs",
    "favourite": true,
    "favouritedCount": 0,
    "id": "10000",
    "jql": "type = Bug and resolution is empty",
    "name": "All Open Bugs",
    "owner": {
      "accountId": "5b10a2844c20165700ede21g",
      "accountType": "atlassian",
      "active": false,
      "avatarUrls": {
        "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
        "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
        "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
        "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      },
      "displayName": "Mia Krystof",
      "key": "",
      "name": "",
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
    },
    "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
    "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
    "sharePermissions": [],
    "subscriptions": {
      "end-index": 0,
      "items": [],
      "max-results": 0,
      "size": 0,
      "start-index": 0
    },
    "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
  },
  {
    "approximateLastUsed": null,
    "description": "Issues assigned to me",
    "favourite": true,
    "favouritedCount": 0,
    "id": "10010",
    "jql": "assignee = currentUser() and resolution is empty",
    "name": "My issues",
    "owner": {
      "accountId": "5b10a2844c20165700ede21g",
      "accountType": "atlassian",
      "active": false,
      "avatarUrls": {
        "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
        "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
        "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
        "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      },
      "displayName": "Mia Krystof",
      "key": "",
      "name": "",
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
    },
    "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
    "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
    "sharePermissions": [
      {
        "id": 10000,
        "type": "global"
      },
      {
        "id": 10010,
        "project": {
          "avatarUrls": {
            "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
            "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
            "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
            "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          },
          "id": "10000",
          "insight": {
            "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
            "totalIssueCount": 100
          },
          "key": "EX",
          "name": "Example",
          "projectCategory": {
            "description": "First Project Category",
            "id": "10000",
            "name": "FIRST",
            "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          },
          "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          "simplified": false,
          "style": "classic"
        },
        "type": "project"
      }
    ],
    "subscriptions": {
      "end-index": 0,
      "items": [],
      "max-results": 0,
      "size": 0,
      "start-index": 0
    },
    "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
  }
]

Path

GET /rest/api/3/filter/my @scopes-current read:jira-work @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-my-get

resetColumns

resetColumns(params): Promise<void>
Reset the user's column configuration for the filter to the default.

Permissions required: Permission to access Jira, however, columns are only reset for:
- 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
- params: {
  id: number;
  }
  - id: number
    The ID of the filter.
Returns Promise<void>
Path
DELETE /rest/api/3/filter/{id}/columns @scopes-beta delete:filter.column:jira @scopes-current write:jira-work

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-delete

setColumns

setColumns(params): Promise<unknown>
Sets the columns for a filter. Only navigable fields can be set as columns. Use Get fields to get the list fields in Jira. A navigable field has navigable set to true.

The parameters for this resource are expressed as HTML form data. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:
- 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
- params: {
      id: number;
  } & ({
      columnRequestBody: ColumnRequestBody;
      mediaType?: "application/json";
  } | {
      columnRequestBody: ColumnRequestBody;
      mediaType: "multipart/form-data";
  })
Returns Promise<unknown>
Returned if the request is successful.

Path
PUT /rest/api/3/filter/{id}/columns @scopes-current write:jira-work @scopes-beta write:filter.column:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-put

setFavouriteForFilter

setFavouriteForFilter(params): Promise<Filter>
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
- params: {
  expand?: string;
  id: number;
  }
  - Optionalexpand?: string
    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.
Returns Promise<Filter>
Returned if the request is successful.

example:
```
{
  "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
  "description": "Lists all open bugs",
  "favourite": true,
  "favouritedCount": 0,
  "id": "10000",
  "jql": "type = Bug and resolution is empty",
  "name": "All Open Bugs",
  "owner": {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": false,
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
  },
  "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
  "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
  "sharePermissions": [],
  "subscriptions": {
    "end-index": 0,
    "items": [],
    "max-results": 0,
    "size": 0,
    "start-index": 0
  },
  "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
}
```
Path
PUT /rest/api/3/filter/{id}/favourite @scopes-current write:jira-work @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, write:filter:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-favourite-put

updateFilter

updateFilter(params): Promise<Filter>
Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Permissions required: Permission to access Jira, however the user must own the filter.
Parameters
- params: {
      expand?: string;
      filter: Filter;
      id: number;
      overrideSharePermissions?: boolean;
  }
  - Optionalexpand?: string
    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].
  - filter: Filter
    The filter to update.
    
    Example
  - id: number
    The ID of the filter to update.
  - OptionaloverrideSharePermissions?: boolean
    EXPERIMENTAL: Whether share permissions are overridden to enable the addition of any share permissions to filters. Available to users with Administer Jira global permission.
Returns Promise<Filter>
Returned if the request is successful.

example:
```
{
  "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
  "description": "Lists all open bugs",
  "favourite": true,
  "favouritedCount": 0,
  "id": "10000",
  "jql": "type = Bug and resolution is empty",
  "name": "All Open Bugs",
  "owner": {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": false,
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
  },
  "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
  "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
  "sharePermissions": [],
  "subscriptions": {
    "end-index": 0,
    "items": [],
    "max-results": 0,
    "size": 0,
    "start-index": 0
  },
  "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
}
```
Path
PUT /rest/api/3/filter/{id} @scopes-current write:jira-work @scopes-beta write:filter:jira, read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class FiltersService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns FiltersService

Methods

changeFilterOwner

Parameters

changeFilterOwner: ChangeFilterOwner

Example

id: number

Returns Promise<void>

Path

See

createFilter

Parameters

Optionalexpand?: string

filter: Filter

Example

OptionaloverrideSharePermissions?: boolean

Returns Promise<Filter>

Path

See

deleteFavouriteForFilter

Parameters

Optionalexpand?: string

id: number

Returns Promise<Filter>

Path

See

deleteFilter

Parameters

id: number

Returns Promise<void>

Path

See

getColumns

Parameters

id: number

Returns Promise<ColumnItem[]>

Path

See

getFavouriteFilters

Parameters

Optionalexpand?: string

Returns Promise<Filter[]>

Path

See

getFilter

Parameters

Optionalexpand?: string

id: number

OptionaloverrideSharePermissions?: boolean

Returns Promise<Filter>

Path

See

getFiltersPaginated

Parameters

OptionalaccountId?: string

Optionalexpand?: string

OptionalfilterName?: string

OptionalgroupId?: string

Optionalgroupname?: string

Optionalid?: number[]

OptionalisSubstringMatch?: boolean

OptionalmaxResults?: number

OptionaloverrideSharePermissions?: boolean

Optionalowner?: string

OptionalprojectId?: number

OptionalstartAt?: number

Returns Promise<PageBeanFilterDetails>

Path

See

getMyFilters

`Optional`expand?: string

`Optional`overrideSharePermissions?: boolean

`Optional`expand?: string

`Optional`expand?: string

`Optional`expand?: string

`Optional`overrideSharePermissions?: boolean

`Optional`accountId?: string

`Optional`expand?: string

`Optional`filterName?: string

`Optional`groupId?: string

`Optional`groupname?: string

`Optional`id?: number[]

`Optional`isSubstringMatch?: boolean

`Optional`maxResults?: number

`Optional`overrideSharePermissions?: boolean

`Optional`owner?: string

`Optional`projectId?: number

`Optional`startAt?: number

`Optional`expand?: string

`Optional`includeFavourites?: boolean

`Optional`expand?: string

`Optional`expand?: string

`Optional`overrideSharePermissions?: boolean

`Protected` `Static`initialize