Options
All
  • Public
  • Public/Protected
  • All
Menu

Details about a filter.

Hierarchy

  • Filter

Index

Properties

Optional description

description: string

A description of the filter.

Optional editPermissions

editPermissions: SharePermission[]

The groups and projects that can edit the filter.

Optional favourite

favourite: boolean

Whether the filter is selected as a favorite.

Optional favouritedCount

favouritedCount: number

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

format

int64

Optional id

id: string

The unique identifier for the filter.

Optional jql

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.

Optional owner

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.

Optional searchUrl

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/2/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug.

format

uri

Optional self

self: string

The URL of the filter.

format

uri

Optional sharePermissions

sharePermissions: SharePermission[]

The groups and projects that the filter is shared with.

Optional sharedUsers

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.

Optional subscriptions

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

Optional viewUrl

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.

format

uri

Legend

  • Namespace
  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class
  • Class with type parameter
  • Enumeration

Generated using TypeDoc