Interface FilterDetails

Details of a filter.

interface FilterDetails {
    approximateLastUsed?: string;
    description?: string;
    editPermissions?: SharePermission[];
    expand?: string;
    favourite?: boolean;
    favouritedCount?: number;
    id?: string;
    jql?: string;
    name: string;
    owner?: User;
    searchUrl?: string;
    self?: string;
    sharePermissions?: SharePermission[];
    subscriptions?: FilterSubscription[];
    viewUrl?: string;
}

Properties

approximateLastUsed? description? editPermissions? expand? favourite? favouritedCount? id? jql? name owner? searchUrl? self? 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

The description of the filter.

OptionaleditPermissions

editPermissions?: SharePermission[]

The groups and projects that can edit the filter. This can be specified when updating a filter, but not when creating a filter.

Optionalexpand

expand?: string

Expand options that include additional filter details in the response.

Optionalfavourite

favourite?: boolean

Whether the filter is selected as a favorite by any users, not including the filter owner.

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.

Optionalowner

owner?: User

The user who owns the filter. Defaults 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.

OptionalsharePermissions

sharePermissions?: SharePermission[]

The groups and projects that the filter is shared with. This can be specified when updating a filter, but not when creating a filter.

Optionalsubscriptions

subscriptions?: FilterSubscription[]

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