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

Class IssuePrioritiesApi

java.lang.Object

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

public class IssuePrioritiesApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<PriorityId>	createPriority(Map<String,Object> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create priority Creates an issue priority.
io.reactivex.Completable	deletePriority(String id, String replaceWith, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Deprecated.
io.reactivex.Single<List<Priority>>	getPriorities(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Deprecated.
io.reactivex.Single<Priority>	getPriority(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get priority Returns an issue priority.
io.reactivex.Single<Object>	movePriorities(ReorderIssuePriorities reorderIssuePriorities, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Move priorities Changes the order of issue priorities.
io.reactivex.Single<PageBeanPriority>	searchPriorities(Optional<String> startAt, Optional<String> maxResults, Optional<List<String>> id, Optional<List<String>> projectId, Optional<String> priorityName, Optional<Boolean> onlyDefault, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Search priorities Returns a [paginated](#pagination) list of priorities.
io.reactivex.Single<Object>	setDefaultPriority(SetDefaultPriorityRequest setDefaultPriorityRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set default priority Sets default issue priority.
io.reactivex.Single<Object>	updatePriority(String id, Map<String,Object> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update priority Updates an issue priority.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssuePrioritiesApi

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

Method Detail

createPriority

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

Create priority Creates an issue priority. **[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<PriorityId>

deletePriority

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

Deprecated.

Delete priority *Deprecated: please refer to the* [changelog](https://developer.atlassian.com/changelog/#CHANGE-1066) *for more details.* Deletes an issue priority. 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 priority. (required)

replaceWith - The ID of the issue priority 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

getPriorities

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

Deprecated.

Get priorities Returns the list of all issue priorities. **[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<Priority>>

getPriority

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

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

Parameters:

id - The ID of the issue priority. (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<Priority>

movePriorities

public io.reactivex.Single<Object> movePriorities(ReorderIssuePriorities reorderIssuePriorities,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

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

Parameters:

reorderIssuePriorities - (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>

searchPriorities

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

Search priorities Returns a [paginated](#pagination) list of priorities. The list can contain all priorities or a subset determined by any combination of these criteria: * a list of priority IDs. Any invalid priority IDs are ignored. * a list of project IDs. Only priorities that are available in these projects will be returned. Any invalid project IDs are ignored. * whether the field configuration is a default. This returns priorities from company-managed (classic) projects only, as there is no concept of default priorities 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 priority IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=2&id=3`. (optional, default to new ArrayList<>())

projectId - The list of projects IDs. To include multiple IDs, provide an ampersand-separated list. For example, `projectId=10010&projectId=10111`. (optional, default to new ArrayList<>())

priorityName - The name of priority to search for. (optional, default to "")

onlyDefault - Whether only the default priority is returned. (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<PageBeanPriority>

setDefaultPriority

public io.reactivex.Single<Object> setDefaultPriority(SetDefaultPriorityRequest setDefaultPriorityRequest,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

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

Parameters:

setDefaultPriorityRequest - (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>

updatePriority

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

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

Parameters:

id - The ID of the issue priority. (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>