Interface Filter

Details about a filter.

interface Filter {
    approximateLastUsed?: string;
    description?: string;
    editPermissions?: SharePermission[];
    favourite?: boolean;
    favouritedCount?: number;
    id?: string;
    jql?: string;
    name: string;
    owner?: User;
    searchUrl?: string;
    self?: string;
    sharedUsers?: UserList;
    sharePermissions?: SharePermission[];
    subscriptions?: FilterSubscriptionsList;
    viewUrl?: string;
}

Properties

approximateLastUsed? description? editPermissions? favourite? favouritedCount? id? jql? name owner? searchUrl? self? sharedUsers? sharePermissions? subscriptions? viewUrl?

Properties

OptionalapproximateLastUsed

approximateLastUsed?: string

[Experimental] Approximate last used time. Returns the date and time when the filter was last used. Returns null if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate.

Optionaldescription

description?: string

A description of the filter.

OptionaleditPermissions

editPermissions?: SharePermission[]

The groups and projects that can edit the filter.

Optionalfavourite

favourite?: boolean

Whether the filter is selected as a favorite.

OptionalfavouritedCount

favouritedCount?: number

The count of how many users have selected this filter as a favorite, including the filter owner.

Optionalid

id?: string

The unique identifier for the filter.

Optionaljql

jql?: string

The JQL query for the filter. For example, project = SSP AND issuetype = Bug.

name

name: string

The name of the filter. Must be unique.

Optionalowner

owner?: User

The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings.

OptionalsearchUrl

searchUrl?: string

A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug.

Optionalself

self?: string

The URL of the filter.

OptionalsharedUsers

sharedUsers?: UserList

A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with.

OptionalsharePermissions

sharePermissions?: SharePermission[]

The groups and projects that the filter is shared with.

Optionalsubscriptions

subscriptions?: FilterSubscriptionsList

A paginated list of the users that are subscribed to the filter.

OptionalviewUrl

viewUrl?: string

A URL to view the filter results in Jira, using the ID of the filter. For example, https://your-domain.atlassian.net/issues/?filter=10100.

Settings

Member Visibility

On This Page

Properties