filter

Add share permission

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

POST /rest/api/3/filter/{id}/permission

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--id`	string	Yes	The ID of the filter.

Example:

bash

jr filter add-share-permission --id <id>

change-owner

Change filter owner

Changes the owner of the filter.

Permissions required: Permission to access Jira. However, the user must own the filter or have the Administer Jira global permission.

PUT /rest/api/3/filter/{id}/owner

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--id`	string	Yes	The ID of the filter to update.

Example:

bash

jr filter change-owner --id <id>

create

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.

POST /rest/api/3/filter

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--expand`	string	No	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]. | | --overrideSharePermissions | string | No | EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with Administer Jira global permission. |

Example:

bash

jr filter create

delete

Delete filter

Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

DELETE /rest/api/3/filter/{id}

Flag	Type	Required	Description
`--id`	string	Yes	The ID of the filter to delete.

Example:

bash

jr filter delete --id <id>

delete-favourite-for

Remove filter as favorite

Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.

Permissions required: Permission to access Jira.

DELETE /rest/api/3/filter/{id}/favourite

Flag	Type	Required	Description
`--expand`	string	No	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]. | | --id | string | Yes | The ID of the filter. |

Example:

bash

jr filter delete-favourite-for --id <id>

Delete share permission

Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.

DELETE /rest/api/3/filter/{id}/permission/{permissionId}

Flag	Type	Required	Description
`--id`	string	Yes	The ID of the filter.
`--permissionId`	string	Yes	The ID of the share permission.

Example:

bash

jr filter delete-share-permission --id <id> --permissionId <permissionId>

get

Get filter

Returns a filter.

This operation can be accessed anonymously.

Permissions required: None, however, the filter is only returned where it is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

GET /rest/api/3/filter/{id}

Flag	Type	Required	Description
`--expand`	string	No	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]. | | --id | string | Yes | The ID of the filter to return. | | --overrideSharePermissions | string | No | EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with Administer Jira global permission. |

Example:

bash

jr filter get --id <id>

get-columns

Get columns

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in List View with the Columns set to Filter.

This operation can be accessed anonymously.

Permissions required: None, however, column details are only returned for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

GET /rest/api/3/filter/{id}/columns

Flag	Type	Required	Description
`--id`	string	Yes	The ID of the filter.

Example:

bash

jr filter get-columns --id <id>

Get default share scope

Returns the default sharing settings for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

GET /rest/api/3/filter/defaultShareScope

Example:

bash

jr filter get-default-share-scope

get-favourite

Get favorite filters

Returns the visible favorite filters of the user.

This operation can be accessed anonymously.

Permissions required: A favorite filter is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

GET /rest/api/3/filter/favourite

Flag	Type	Required	Description
`--expand`	string	No	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]. |

Example:

bash

jr filter get-favourite

get-my

Get my filters

Returns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

GET /rest/api/3/filter/my

Flag	Type	Required	Description
`--expand`	string	No	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]. | | --includeFavourites | string | No | Include the user's favorite filters in the response. |

Example:

bash

jr filter get-my

get-paginated

Search for filters

Returns a paginated list of filters. Use this operation to get:

specific filters, by defining id only.
filters that match all of the specified attributes. For example, all filters for a user with a particular word in their name. When multiple attributes are specified only filters matching all attributes are returned.

This operation can be accessed anonymously.

Permissions required: None, however, only the following filters that match the query parameters are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

GET /rest/api/3/filter/search

Flag	Type	Required	Description
`--accountId`	string	No	User account ID used to return filters with the matching `owner.accountId`. This parameter cannot be used with `owner`.
`--expand`	string	No	Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

description Returns the description of the filter.
favourite Returns an indicator of whether the user has set the filter as a favorite.
favouritedCount Returns a count of how many users have set this filter as a favorite.
jql Returns the JQL query that the filter uses.
owner Returns the owner of the filter.
searchUrl Returns a URL to perform the filter's JQL query.
sharePermissions Returns the share permissions defined for the filter.
editPermissions Returns the edit permissions defined for the filter.
isWritable Returns whether the current user has permission to edit the filter.
approximateLastUsed [Experimental] Returns the approximate date and time when the filter was last evaluated.
subscriptions Returns the users that are subscribed to the filter.
viewUrl Returns a URL to view the filter. | | --filterName | string | No | String used to perform a case-insensitive partial match with name. | | --groupId | string | No | Group ID used to returns filters that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter. | | --groupname | string | No | As a group's name can change, use of groupId is recommended to identify a group. Group name used to returns filters that are shared with a group that matches sharePermissions.group.groupname. This parameter cannot be used with the groupId parameter. | | --id | string | No | The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Do not exceed 200 filter IDs. | | --isSubstringMatch | string | No | When true this will perform a case-insensitive substring match for the provided filterName. When false the filter name will be searched using full text search syntax. | | --maxResults | string | No | The maximum number of items to return per page. | | --orderBy | string | No | Order the results by a field:
description Sorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use.
favourite_count Sorts by the count of how many users have this filter as a favorite.
is_favourite Sorts by whether the filter is marked as a favorite.
id Sorts by filter ID.
name Sorts by filter name.
owner Sorts by the ID of the filter owner.
is_shared Sorts by whether the filter is shared. | | --overrideSharePermissions | string | No | EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with Administer Jira global permission. | | --owner | string | No | This parameter is deprecated because of privacy changes. Use accountId instead. See the migration guide for details. User name used to return filters with the matching owner.name. This parameter cannot be used with accountId. | | --projectId | string | No | Project ID used to returns filters that are shared with a project that matches sharePermissions.project.id. | | --startAt | string | No | The index of the first item to return in a page of results (page offset). |

Example:

bash

jr filter get-paginated

Get share permission

Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

This operation can be accessed anonymously.

Permissions required: None, however, a share permission is only returned for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

GET /rest/api/3/filter/{id}/permission/{permissionId}

Flag	Type	Required	Description
`--id`	string	Yes	The ID of the filter.
`--permissionId`	string	Yes	The ID of the share permission.

Example:

bash

jr filter get-share-permission --id <id> --permissionId <permissionId>

Get share permissions

Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

This operation can be accessed anonymously.

Permissions required: None, however, share permissions are only returned for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

GET /rest/api/3/filter/{id}/permission

Flag	Type	Required	Description
`--id`	string	Yes	The ID of the filter.

Example:

bash

jr filter get-share-permissions --id <id>

reset-columns

Reset columns

Reset the user's column configuration for the filter to the default.

Permissions required: Permission to access Jira, however, columns are only reset for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

DELETE /rest/api/3/filter/{id}/columns

Flag	Type	Required	Description
`--id`	string	Yes	The ID of the filter.

Example:

bash

jr filter reset-columns --id <id>

set-columns

Set columns

Sets the columns for a filter. Only navigable fields can be set as columns. Use Get fields to get the list fields in Jira. A navigable field has navigable set to true.

The parameters for this resource are expressed as HTML form data. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

PUT /rest/api/3/filter/{id}/columns

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--id`	string	Yes	The ID of the filter.

Example:

bash

jr filter set-columns --id <id>

Set default share scope

Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

PUT /rest/api/3/filter/defaultShareScope

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)

Example:

bash

jr filter set-default-share-scope

set-favourite-for

Add filter as favorite

Add a filter as a favorite for the user.

Permissions required: Permission to access Jira, however, the user can only favorite:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

PUT /rest/api/3/filter/{id}/favourite

Flag	Type	Required	Description
`--expand`	string	No	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]. | | --id | string | Yes | The ID of the filter. |

Example:

bash

jr filter set-favourite-for --id <id>

update

Update filter

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Permissions required: Permission to access Jira, however the user must own the filter.

PUT /rest/api/3/filter/{id}

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--expand`	string	No	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]. | | --id | string | Yes | The ID of the filter to update. | | --overrideSharePermissions | string | No | EXPERIMENTAL: Whether share permissions are overridden to enable the addition of any share permissions to filters. Available to users with Administer Jira global permission. |

Example:

bash

jr filter update --id <id>

filter ​

add-share-permission ​

change-owner ​

create ​

delete ​

delete-favourite-for ​

delete-share-permission ​

get ​

get-columns ​

get-default-share-scope ​

get-favourite ​

get-my ​

get-paginated ​

get-share-permission ​

get-share-permissions ​

reset-columns ​

set-columns ​

set-default-share-scope ​

set-favourite-for ​

update ​

filter

add-share-permission

change-owner

create

delete

delete-favourite-for

delete-share-permission

get

get-columns

get-default-share-scope

get-favourite

get-my

get-paginated

get-share-permission

get-share-permissions

reset-columns

set-columns

set-default-share-scope

set-favourite-for

update