Interface UpdateFilter

interface UpdateFilter {
    description?: string;
    editPermissions?: Version3.Version3Models.SharePermission[];
    expand?: string | string[] | ("sharedUsers" | "subscriptions")[];
    favourite?: boolean;
    favouritedCount?: number;
    id: number;
    jql?: string;
    name: string;
    overrideSharePermissions?: boolean;
    owner?: Version3.Version3Models.User;
    searchUrl?: string;
    self?: string;
    sharePermissions?: Version3.Version3Models.SharePermission[];
    sharedUsers?: Version3.Version3Models.UserList;
    subscriptions?: Version3.Version3Models.FilterSubscriptionsList;
    viewUrl?: string;
}

Hierarchy

Properties

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

Properties

Optional description

description?: string

A description of the filter.

Optional editPermissions

editPermissions?: Version3.Version3Models.SharePermission[]

The groups and projects that can edit the filter.

Optional expand

expand?: string | string[] | ("sharedUsers" | "subscriptions")[]

Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

  • sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000].
  • subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].

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.

id

id: number

The ID of the filter to update.

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 overrideSharePermissions

overrideSharePermissions?: boolean

EXPERIMENTAL: Whether share permissions are overridden to enable the addition of any share permissions to filters. Available to users with Administer Jira global permission.

Optional owner

owner?: Version3.Version3Models.User

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

Optional self

self?: string

The URL of the filter.

Optional sharePermissions

sharePermissions?: Version3.Version3Models.SharePermission[]

The groups and projects that the filter is shared with.

Optional sharedUsers

sharedUsers?: Version3.Version3Models.UserList

Optional subscriptions

subscriptions?: Version3.Version3Models.FilterSubscriptionsList

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.

Settings

Member Visibility

Theme

On This Page

descriptioneditPermissionsexpandfavouritefavouritedCountidjqlnameoverrideSharePermissionsownersearchUrlselfsharePermissionssharedUserssubscriptionsviewUrl