Create filter

Creates a filter. The filter is shared according to the default share scope. The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

expandstring

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].

overrideSharePermissionsboolean

EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with Administer Jira global permission.

Request body

approximateLastUsedstring date-time

[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.

descriptionstring

A description of the filter.

favouriteboolean

Whether the filter is selected as a favorite.

favouritedCountinteger

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

idstring

The unique identifier for the filter.

jqlstring

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

namestring required

The name of the filter. Must be unique.

searchUrlstring uri

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.

selfstring uri

The URL of the filter.

viewUrlstring uri

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.

Response

Returned if the request is successful.