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

Class ScreensApi

java.lang.Object

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

public class ScreensApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Object>	addFieldToDefaultScreen(String fieldId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add field to default screen Adds a field to the default tab of the default screen.
io.reactivex.Single<Screen>	createScreen(ScreenDetails screenDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create screen Creates a screen with a default field tab.
io.reactivex.Completable	deleteScreen(Long screenId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete screen Deletes a screen.
io.reactivex.Single<List<ScreenableField>>	getAvailableScreenFields(Long screenId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get available screen fields Returns the fields that can be added to a tab on a screen.
io.reactivex.Single<PageBeanScreen>	getScreens(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<Long>> id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get screens Returns a [paginated](#pagination) list of all screens or those specified by one or more screen IDs.
io.reactivex.Single<PageBeanScreen>	getScreensForField(String fieldId, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get screens for a field Returns a [paginated](#pagination) list of the screens a field is used in.
io.reactivex.Single<Screen>	updateScreen(Long screenId, UpdateScreenDetails updateScreenDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update screen Updates a screen.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScreensApi

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

Method Detail

addFieldToDefaultScreen

public io.reactivex.Single<Object> addFieldToDefaultScreen(String fieldId,
                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add field to default screen Adds a field to the default tab of the default screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the field. (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>

createScreen

public io.reactivex.Single<Screen> createScreen(ScreenDetails screenDetails,
                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

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

Parameters:

screenDetails - (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<Screen>

deleteScreen

public io.reactivex.Completable deleteScreen(Long screenId,
                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete screen Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft. Only screens used in classic projects can be deleted.

Parameters:

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

getAvailableScreenFields

public io.reactivex.Single<List<ScreenableField>> getAvailableScreenFields(Long screenId,
                                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get available screen fields Returns the fields that can be added to a tab on a screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

screenId - The ID of the screen. (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<List<ScreenableField>>

getScreens

public io.reactivex.Single<PageBeanScreen> getScreens(Optional<Long> startAt,
                                                      Optional<Integer> maxResults,
                                                      Optional<List<Long>> id,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get screens Returns a [paginated](#pagination) list of all screens or those specified by one or more screen IDs. **[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 100)

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

restRequestEnhancer -

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

Returns:

Single<PageBeanScreen>

getScreensForField

public io.reactivex.Single<PageBeanScreen> getScreensForField(String fieldId,
                                                              Optional<Long> startAt,
                                                              Optional<Integer> maxResults,
                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get screens for a field Returns a [paginated](#pagination) list of the screens a field is used in. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the field to return screens for. (required)

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 100)

restRequestEnhancer -

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

Returns:

Single<PageBeanScreen>

updateScreen

public io.reactivex.Single<Screen> updateScreen(Long screenId,
                                                UpdateScreenDetails updateScreenDetails,
                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

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

Parameters:

screenId - The ID of the screen. (required)

updateScreenDetails - (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<Screen>