org.everit.atlassian.restclient.jiracloud.v3.api

Class StatusApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.StatusApi

public class StatusApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<StatusDetails>	getStatus(String idOrName, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get status Returns a status.
io.reactivex.Single<List<StatusDetails>>	getStatuses(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all statuses Returns a list of all statuses associated with workflows.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusApi

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

Method Detail

getStatus

public io.reactivex.Single<StatusDetails> getStatus(String idOrName,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get status

Returns a status. The status must be associated with a workflow to be returned.

If a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable.

This operation can be accessed anonymously.

Permissions required: None.

Parameters:

idOrName -

The ID or name of the status.

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

getStatuses

public io.reactivex.Single<List<StatusDetails>> getStatuses(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all statuses

Returns a list of all statuses associated with workflows.

This operation can be accessed anonymously.

Permissions required: None.

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<StatusDetails>>