Jira.js - Jira Cloud API library
    Preparing search index...

    Interface Filter

    Details about a filter.

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    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.

    description?: string

    A description of the filter.

    editPermissions?: Version3Models.SharePermission[]

    The groups and projects that can edit the filter.

    favourite?: boolean

    Whether the filter is selected as a favorite.

    favouritedCount?: number

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

    id?: string

    The unique identifier for the filter.

    jql?: string

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

    name: string

    The name of the filter. Must be unique.

    owner?: Version3Models.User
    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_.

    self?: string

    The URL of the filter.

    sharedUsers?: Version3Models.UserList
    sharePermissions?: Version3Models.SharePermission[]

    The groups and projects that the filter is shared with.

    subscriptions?: Version3Models.FilterSubscriptionsList
    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