Interface JiraFilter

A saved Jira filter.

interface JiraFilter {
    description?: string;
    favourite?: boolean;
    favouritedCount?: number;
    id: string;
    jql: string;
    name: string;
    owner?: JiraUser;
    searchUrl?: string;
    self: string;
    sharePermissions?: JiraFilterPermission[];
    subscriptions?: { items: unknown[]; size: number };
    viewUrl?: string;
}

Properties

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

Properties

Optionaldescription

description?: string

Filter description

Optionalfavourite

favourite?: boolean

Whether the filter is a favourite of the authenticated user

OptionalfavouritedCount

favouritedCount?: number

Number of users who have marked this filter as a favourite

id

id: string

Numeric string ID

jql

jql: string

The JQL query string

name

name: string

Filter name

Optionalowner

owner?: JiraUser

User who created the filter

OptionalsearchUrl

searchUrl?: string

URL to the filter REST resource

self

self: string

URL of the filter resource

OptionalsharePermissions

sharePermissions?: JiraFilterPermission[]

Shared permissions

Optionalsubscriptions

subscriptions?: { items: unknown[]; size: number }

Subscriptions to this filter

OptionalviewUrl

viewUrl?: string

URL to view the filter results

Settings

Member Visibility

On This Page

Properties