Server
Jira Data Center / Reference / REST API

filter

Postman Collection
Operations
POST/api/2/filterGET/api/2/filter/defaultShareScopePUT/api/2/filter/defaultShareScopeGET/api/2/filter/favouriteGET/api/2/filter/{id}PUT/api/2/filter/{id}DEL/api/2/filter/{id}GET/api/2/filter/{id}/columnsPUT/api/2/filter/{id}/columnsDEL/api/2/filter/{id}/columnsGET/api/2/filter/{id}/permissionPOST/api/2/filter/{id}/permissionDEL/api/2/filter/{id}/permission/{permission-id}GET/api/2/filter/{id}/permission/{permissionId}
POST

Create a new filter

Creates a new filter, and returns newly created filter. Currently sets permissions just using the users default sharing permissions

Request

Query parameters

expand

StringList

Request bodyapplication/json

description

string

editable

boolean

favourite

boolean

id

string

jql

string

name

string

owner

UserBean

searchUrl

string

self

string

sharePermissions

array<FilterPermissionBean>

Responses

Returns a newly created filter

application/json

FilterBean
POST/api/2/filter
1 2 3 4 5 curl --request POST \ --url 'http://{baseurl}/rest/api/2/filter' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
GET

Get default share scope

Returns the default share scope of the logged-in user

Request

This request has no parameters.

Responses

Returns the default share scope of the logged-in user

application/json

DefaultShareScopeBean
GET/api/2/filter/defaultShareScope
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/filter/defaultShareScope' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
PUT

Set default share scope

Sets the default share scope of the logged-in user. Available values are: AUTHENTICATED (for sharing with all logged-in users) and PRIVATE (for no shares).

Request

Request bodyapplication/json

scope

string

Responses

Returns the new default share scope of the logged-in user

application/json

DefaultShareScopeBean
PUT/api/2/filter/defaultShareScope
1 2 3 4 5 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/filter/defaultShareScope' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
GET

Get favourite filters

Returns the favourite filters of the logged-in user

Request

Query parameters

expand

StringList

Responses

Returns a list of favourite filters

application/json

FilterBean
GET/api/2/filter/favourite
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/filter/favourite' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get a filter by ID

Returns a filter given an id

Request

Path parameters

id

string

Required

Query parameters

expand

StringList

Responses

Returns a filter

application/json

FilterBean
GET/api/2/filter/{id}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/filter/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
PUT

Update an existing filter

Updates an existing filter, and returns its new value. The following properties of a filter can be updated: 'jql', 'name', 'description'. Additionally, administrators can also update the 'owner' field. To get, set or unset 'favourite', use rest/api/1.0/filters/{id}/favourite with GET, PUT and DELETE methods instead.

Request

Path parameters

id

string

Required

Query parameters

expand

StringList

Request bodyapplication/json

description

string

editable

boolean

favourite

boolean

id

string

jql

string

name

string

owner

UserBean

searchUrl

string

self

string

sharePermissions

array<FilterPermissionBean>

Responses

Returns the updated filter

application/json

FilterBean
PUT/api/2/filter/{id}
1 2 3 4 5 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/filter/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
DEL

Delete a filter

Delete a filter

Request

Path parameters

id

string

Required

Responses

Returned if the filter was removed successfully.

DEL/api/2/filter/{id}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/filter/{id}' \ --user 'email@example.com:<api_token>'
GET

Get default columns for filter

Returns the default columns for the given filter. Currently logged in user will be used as the user making such request.

Request

Path parameters

id

string

Required

Responses

Returns a list of columns for configured for the given user

application/json

ColumnLayout
GET/api/2/filter/{id}/columns
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/filter/{id}/columns' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
PUT

Set default columns for filter

Sets the default columns for the given filter

Request

Path parameters

id

string

Required

Request body*/*

columns

array<string>

Responses

Returned when the columns are saved successfully

PUT/api/2/filter/{id}/columns
1 2 3 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/filter/{id}/columns' \ --user 'email@example.com:<api_token>'
DEL

Reset columns for filter

Resets the columns for the given filter such that the filter no longer has its own column config

Request

Path parameters

id

string

Required

Responses

Returned when the columns are reset/removed successfully

DEL/api/2/filter/{id}/columns
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/filter/{id}/columns' \ --user 'email@example.com:<api_token>'
GET

Get all share permissions of filter

Returns all share permissions of the given filter

Request

Path parameters

id

string

Required

Responses

Returns a list of share permissions associated with the given filter

application/json

FilterPermissionBean
GET/api/2/filter/{id}/permission
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/filter/{id}/permission' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Add share permissions to filter

Adds a share permissions to the given filter. Adding a global permission removes all previous permissions from the filter

Request

Path parameters

id

string

Required

Request bodyapplication/json

edit

boolean

groupname

string

projectId

string

projectRoleId

string

type

string

userKey

string

view

boolean

Responses

Returns share permissions associated with the given filter

application/json

FilterPermissionBean
POST/api/2/filter/{id}/permission
1 2 3 4 5 curl --request POST \ --url 'http://{baseurl}/rest/api/2/filter/{id}/permission' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
DEL

Remove share permissions from filter

Removes a share permissions from the given filter

Request

Path parameters

permissionId

string

Required
id

string

Required
permission-id

integer

Required

Responses

Returned if successful.

DEL/api/2/filter/{id}/permission/{permission-id}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/filter/{id}/permission/{permission-id}' \ --user 'email@example.com:<api_token>'
GET

Get a single share permission of filter

Returns a single share permission of the given filter

Request

Path parameters

permissionId

string

Required
id

string

Required

Responses

Returns a share permission associated with the given filter and permission-id

application/json

FilterPermissionBean
GET/api/2/filter/{id}/permission/{permissionId}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/filter/{id}/permission/{permissionId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'

Rate this page: