org.everit.atlassian.restclient.jiracloud.v2.api

Class IssueResolutionsApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.IssueResolutionsApi

public class IssueResolutionsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
IssueResolutionsApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<ResolutionId>	createResolution(Map<String,Object> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create resolution Creates an issue resolution.
io.reactivex.Completable	deleteResolution(String id, String replaceWith, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete resolution Deletes an issue resolution.
io.reactivex.Single<Resolution>	getResolution(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get resolution Returns an issue resolution value.
io.reactivex.Single<List<Resolution>>	getResolutions(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Deprecated.
io.reactivex.Single<Object>	moveResolutions(ReorderIssueResolutionsRequest reorderIssueResolutionsRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Move resolutions Changes the order of issue resolutions.
io.reactivex.Single<PageBeanResolutionJsonBean>	searchResolutions(Optional<String> startAt, Optional<String> maxResults, Optional<List<String>> id, Optional<Boolean> onlyDefault, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Search resolutions Returns a [paginated](#pagination) list of resolutions.
io.reactivex.Single<Object>	setDefaultResolution(SetDefaultResolutionRequest setDefaultResolutionRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set default resolution Sets default issue resolution.
io.reactivex.Single<Object>	updateResolution(String id, Map<String,Object> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update resolution Updates an issue resolution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IssueResolutionsApi

public IssueResolutionsApi(org.everit.http.restclient.RestClient restClient)

Method Detail

createResolution

public io.reactivex.Single<ResolutionId> createResolution(Map<String,Object> requestBody,
                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create resolution Creates an issue resolution. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

requestBody - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<ResolutionId>

deleteResolution

public io.reactivex.Completable deleteResolution(String id,
                                                 String replaceWith,
                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete resolution Deletes an issue resolution. This operation is [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-2-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the issue resolution. (required)

replaceWith - The ID of the issue resolution that will replace the currently selected resolution. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable

getResolution

public io.reactivex.Single<Resolution> getResolution(String id,
                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get resolution Returns an issue resolution value. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

id - The ID of the issue resolution value. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Resolution>

getResolutions

@Deprecated
public io.reactivex.Single<List<Resolution>> getResolutions(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Deprecated.

Get resolutions Returns a list of all issue resolution values. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<List<Resolution>>

moveResolutions

public io.reactivex.Single<Object> moveResolutions(ReorderIssueResolutionsRequest reorderIssueResolutionsRequest,
                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Move resolutions Changes the order of issue resolutions. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

reorderIssueResolutionsRequest - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>

searchResolutions

public io.reactivex.Single<PageBeanResolutionJsonBean> searchResolutions(Optional<String> startAt,
                                                                         Optional<String> maxResults,
                                                                         Optional<List<String>> id,
                                                                         Optional<Boolean> onlyDefault,
                                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Search resolutions Returns a [paginated](#pagination) list of resolutions. The list can contain all resolutions or a subset determined by any combination of these criteria: * a list of resolutions IDs. * whether the field configuration is a default. This returns resolutions from company-managed (classic) projects only, as there is no concept of default resolutions in team-managed projects. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

startAt - The index of the first item to return in a page of results (page offset). (optional, default to "0")

maxResults - The maximum number of items to return per page. (optional, default to "50")

id - The list of resolutions IDs to be filtered out (optional, default to new ArrayList<>())

onlyDefault - When set to true, return default only, when IDs provided, if none of them is default, return empty page. Default value is false (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.

Returns:

Single<PageBeanResolutionJsonBean>

setDefaultResolution

public io.reactivex.Single<Object> setDefaultResolution(SetDefaultResolutionRequest setDefaultResolutionRequest,
                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set default resolution Sets default issue resolution. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

setDefaultResolutionRequest - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>

updateResolution

public io.reactivex.Single<Object> updateResolution(String id,
                                                    Map<String,Object> requestBody,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update resolution Updates an issue resolution. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the issue resolution. (required)

requestBody - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>