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

Class ScreenTabFieldsApi

java.lang.Object

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

public class ScreenTabFieldsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<ScreenableField>	addScreenTabField(Long screenId, Long tabId, AddFieldBean addFieldBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add screen tab field Adds a field to a screen tab.
io.reactivex.Single<List<ScreenableField>>	getAllScreenTabFields(Long screenId, Long tabId, Optional<String> projectKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all screen tab fields Returns all fields for a screen tab.
io.reactivex.Single<Object>	moveScreenTabField(Long screenId, Long tabId, String id, MoveFieldBean moveFieldBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Move screen tab field Moves a screen tab field.
io.reactivex.Completable	removeScreenTabField(Long screenId, Long tabId, String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove screen tab field Removes a field from a screen tab.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScreenTabFieldsApi

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

Method Detail

addScreenTabField

public io.reactivex.Single<ScreenableField> addScreenTabField(Long screenId,
                                                              Long tabId,
                                                              AddFieldBean addFieldBean,
                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

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

Parameters:

screenId - The ID of the screen. (required)

tabId - The ID of the screen tab. (required)

addFieldBean - (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<ScreenableField>

getAllScreenTabFields

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

Get all screen tab fields Returns all fields for a screen tab. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.

Parameters:

screenId - The ID of the screen. (required)

tabId - The ID of the screen tab. (required)

projectKey - The key of the project. (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<List<ScreenableField>>

moveScreenTabField

public io.reactivex.Single<Object> moveScreenTabField(Long screenId,
                                                      Long tabId,
                                                      String id,
                                                      MoveFieldBean moveFieldBean,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Move screen tab field Moves a screen tab field. If `after` and `position` are provided in the request, `position` is ignored. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

screenId - The ID of the screen. (required)

tabId - The ID of the screen tab. (required)

id - The ID of the field. (required)

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

removeScreenTabField

public io.reactivex.Completable removeScreenTabField(Long screenId,
                                                     Long tabId,
                                                     String id,
                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove screen tab field Removes a field from a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

screenId - The ID of the screen. (required)

tabId - The ID of the screen tab. (required)

id - 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:

Completable