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

Class ScreenSchemesApi

java.lang.Object

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

public class ScreenSchemesApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<ScreenSchemeId>	createScreenScheme(ScreenSchemeDetails screenSchemeDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create screen scheme Creates a screen scheme.
io.reactivex.Completable	deleteScreenScheme(String screenSchemeId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete screen scheme Deletes a screen scheme.
io.reactivex.Single<PageBeanScreenScheme>	getScreenSchemes(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<Long>> id, Optional<String> expand, Optional<String> queryString, Optional<String> orderBy, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get screen schemes Returns a [paginated](#pagination) list of screen schemes.
io.reactivex.Single<Object>	updateScreenScheme(String screenSchemeId, UpdateScreenSchemeDetails updateScreenSchemeDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update screen scheme Updates a screen scheme.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScreenSchemesApi

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

Method Detail

createScreenScheme

public io.reactivex.Single<ScreenSchemeId> createScreenScheme(ScreenSchemeDetails screenSchemeDetails,
                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

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

Parameters:

screenSchemeDetails - (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<ScreenSchemeId>

deleteScreenScheme

public io.reactivex.Completable deleteScreenScheme(String screenSchemeId,
                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete screen scheme Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme. Only screens schemes used in classic projects can be deleted. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

screenSchemeId - The ID of the screen scheme. (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

getScreenSchemes

public io.reactivex.Single<PageBeanScreenScheme> getScreenSchemes(Optional<Long> startAt,
                                                                  Optional<Integer> maxResults,
                                                                  Optional<List<Long>> id,
                                                                  Optional<String> expand,
                                                                  Optional<String> queryString,
                                                                  Optional<String> orderBy,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get screen schemes Returns a [paginated](#pagination) list of screen schemes. Only screen schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

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. (optional, default to 25)

id - The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (optional, default to new ArrayList<>())

expand - Use [expand](#expansion) include additional information in the response. This parameter accepts `issueTypeScreenSchemes` that, for each screen schemes, returns information about the issue type screen scheme the screen scheme is assigned to. (optional, default to "")

queryString - String used to perform a case-insensitive partial match with screen scheme name. (optional, default to "")

orderBy - [Order](#ordering) the results by a field: * `id` Sorts by screen scheme ID. * `name` Sorts by screen scheme name. (optional)

restRequestEnhancer -

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

Returns:

Single<PageBeanScreenScheme>

updateScreenScheme

public io.reactivex.Single<Object> updateScreenScheme(String screenSchemeId,
                                                      UpdateScreenSchemeDetails updateScreenSchemeDetails,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update screen scheme Updates a screen scheme. Only screen schemes used in classic projects can be updated. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

screenSchemeId - The ID of the screen scheme. (required)

updateScreenSchemeDetails - The screen scheme update details. (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>