public class FilterApi extends Object
| Constructor and Description |
|---|
FilterApi(org.everit.http.restclient.RestClient restClient) |
| Modifier and Type | Method and Description |
|---|---|
io.reactivex.Single<List<SharePermission>> |
addSharePermission(Long id,
SharePermissionInputBean sharePermissionInputBean,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Add share permission
Add a share permissions to a filter.
|
io.reactivex.Single<Filter> |
createFilter(Filter filter,
Optional<String> expand,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Create filter
Creates a filter.
|
io.reactivex.Single<Filter> |
deleteFavouriteForFilter(Long id,
Optional<String> expand,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Remove filter as favorite
Removes a filter as a favorite for the user.
|
io.reactivex.Completable |
deleteFilter(Long id,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Delete filter
Delete a filter.
|
io.reactivex.Completable |
deleteSharePermission(Long id,
Long permissionId,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Delete share permission
Deletes a share permission from a filter.
|
io.reactivex.Single<List<ColumnItem>> |
getColumns(Long id,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get columns
Returns the columns configured for a filter.
|
io.reactivex.Single<DefaultShareScope> |
getDefaultShareScope(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get default share scope
Returns the default sharing settings for new filters and dashboards for a user.
|
io.reactivex.Single<List<Filter>> |
getFavouriteFilters(Optional<String> expand,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get favorite filters
Returns the visible favorite filters of the user.
|
io.reactivex.Single<Filter> |
getFilter(Long id,
Optional<String> expand,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get filter
Returns a filter.
|
io.reactivex.Single<List<Filter>> |
getFilters(Optional<String> expand,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Deprecated.
|
io.reactivex.Single<PageBeanFoundFilter> |
getFiltersPaginated(Optional<String> filterName,
Optional<String> accountId,
Optional<String> owner,
Optional<String> groupname,
Optional<Long> projectId,
Optional<String> orderBy,
Optional<Long> startAt,
Optional<Integer> maxResults,
Optional<String> expand,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Search for filters
Searches for filters.
|
io.reactivex.Single<List<Filter>> |
getMyFilters(Optional<String> expand,
Optional<Boolean> includeFavourites,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get my filters
Returns the filters owned by the user.
|
io.reactivex.Single<SharePermission> |
getSharePermission(Long id,
Long permissionId,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get share permission
Returns a share permission for a filter.
|
io.reactivex.Single<List<SharePermission>> |
getSharePermissions(Long id,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get share permissions
Returns the share permissions for a filter.
|
io.reactivex.Completable |
resetColumns(Long id,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Reset columns
Reset the user's column configuration for the filter to the default.
|
io.reactivex.Single<Object> |
setColumns(Long id,
Optional<List<String>> requestBody,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Set columns
Sets the columns for a filter.
|
io.reactivex.Single<DefaultShareScope> |
setDefaultShareScope(DefaultShareScope defaultShareScope,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Set default share scope
Sets the default sharing for new filters and dashboards for a user.
|
io.reactivex.Single<Filter> |
setFavouriteForFilter(Long id,
Optional<String> expand,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Add filter as favorite
Add a filter as a favorite for the user.
|
io.reactivex.Single<Filter> |
updateFilter(Long id,
Filter filter,
Optional<String> expand,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Update filter
Updates a filter.
|
public io.reactivex.Single<List<SharePermission>> addSharePermission(Long id, SharePermissionInputBean sharePermissionInputBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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.
id - The ID of the filter.
(required)sharePermissionInputBean - (required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<Filter> createFilter(Filter filter, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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.
filter - The filter to create.
(required)expand - Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
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].restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<Filter> deleteFavouriteForFilter(Long id, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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.
id - The ID of the filter.
(required)expand - Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
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].restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Completable deleteFilter(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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.
id - The ID of the filter to delete.
(required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Completable deleteSharePermission(Long id, Long permissionId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Deletes a share permission from a filter.
Permissions required: Permission to access Jira and the user must own the filter.
id - The ID of the filter.
(required)permissionId - The ID of the share permission.
(required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<List<ColumnItem>> getColumns(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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:
id - The ID of the filter.
(required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<DefaultShareScope> getDefaultShareScope(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Returns the default sharing settings for new filters and dashboards for a user.
Permissions required: Permission to access Jira.
restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<List<Filter>> getFavouriteFilters(Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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:
For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.
expand - Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
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].restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<Filter> getFilter(Long id, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Returns a filter.
This operation can be accessed anonymously.
Permissions required: None, however, the filter is only returned where it is:
id - The ID of the filter to return.
(required)expand - Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
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].restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
@Deprecated public io.reactivex.Single<List<Filter>> getFilters(Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Returns all filters. Deprecated, use Search for filters that supports search and pagination.
This operation can be accessed anonymously.
Permissions required: None, however, only the following filters are returned:
expand - Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
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].restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<PageBeanFoundFilter> getFiltersPaginated(Optional<String> filterName, Optional<String> accountId, Optional<String> owner, Optional<String> groupname, Optional<Long> projectId, Optional<String> orderBy, Optional<Long> startAt, Optional<Integer> maxResults, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Searches for filters. This operation is similar to Get filters except that the results can be refined to include filters that have specific attributes. For example, filters with a particular 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:
filterName - String used to perform a case-insensitive partial match with name.
accountId - User account ID used to return filters with the matching owner.accountId. This parameter cannot be used with owner.
owner - 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.
groupname - Group name used to returns filters that are shared with a group that matches sharePermissions.group.groupname.
projectId - Project ID used to returns filters that are shared with a project that matches sharePermissions.project.id.
orderBy - Orders the results using one of these filter properties:
description Orders by filter description. Note that this ordering works independently of whether the expand to display the description field is in use.favourite_count Orders by favouritedCount.is_favourite Orders by favourite.id Orders by filter id.name Orders by filter name.owner Orders by owner.accountId.startAt - The index of the first item to return in a page of results (page offset).
(optional, default to 0l)maxResults - The maximum number of items to return per page. The maximum is 100.
expand - Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
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.subscriptions Returns the users that are subscribed to the filter.viewUrl Returns a URL to view the filter.restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<List<Filter>> getMyFilters(Optional<String> expand, Optional<Boolean> includeFavourites, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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:
For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.
expand - Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
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 - Include the user's favorite filters in the response.
(optional, default to false)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<SharePermission> getSharePermission(Long id, Long permissionId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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:
id - The ID of the filter.
(required)permissionId - The ID of the share permission.
(required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<List<SharePermission>> getSharePermissions(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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:
id - The ID of the filter.
(required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Completable resetColumns(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Reset the user's column configuration for the filter to the default.
Permissions required: Permission to access Jira, however, columns are only reset for:
id - The ID of the filter.
(required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<Object> setColumns(Long id, Optional<List<String>> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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:
id - The ID of the filter.
(required)requestBody - The IDs of the fields to set as columns. In the form data, specify each field as columns=id, where id is the id of a field (as seen in the response for Get fields). For example, columns=summary.
restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<DefaultShareScope> setDefaultShareScope(DefaultShareScope defaultShareScope, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Sets the default sharing for new filters and dashboards for a user.
Permissions required: Permission to access Jira.
defaultShareScope - (required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<Filter> setFavouriteForFilter(Long id, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Add a filter as a favorite for the user.
Permissions required: Permission to access Jira, however, the user can only favorite:
id - The ID of the filter.
(required)expand - Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
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].restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<Filter> updateFilter(Long id, Filter filter, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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.
id - The ID of the filter to update.
(required)filter - The filter to update.
(required)expand - Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
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].restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
Copyright © 2011–2021 Everit Kft.. All rights reserved.