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

Class UiModificationsAppsApi

java.lang.Object

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

public class UiModificationsAppsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<UiModificationIdentifiers>	createUiModification(CreateUiModificationDetails createUiModificationDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create UI modification Creates a UI modification.
io.reactivex.Single<Object>	deleteUiModification(String uiModificationId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete UI modification Deletes a UI modification.
io.reactivex.Single<PageBeanUiModificationDetails>	getUiModifications(Optional<Long> startAt, Optional<Integer> maxResults, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get UI modifications Gets UI modifications.
io.reactivex.Single<Object>	updateUiModification(String uiModificationId, UpdateUiModificationDetails updateUiModificationDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update UI modification Updates a UI modification.

Methods inherited from class java.lang.Object

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

Constructor Detail

UiModificationsAppsApi

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

Method Detail

createUiModification

public io.reactivex.Single<UiModificationIdentifiers> createUiModification(CreateUiModificationDetails createUiModificationDetails,
                                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create UI modification Creates a UI modification. UI modification can only be created by Forge apps. Each app can define up to 3000 UI modifications. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications. **[Permissions](#permissions) required:** * *None* if the UI modification is created without contexts. * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the UI modification is created with contexts.

Parameters:

createUiModificationDetails - Details of the UI modification. (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<UiModificationIdentifiers>

deleteUiModification

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

Delete UI modification Deletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can only be deleted by Forge apps. **[Permissions](#permissions) required:** None.

Parameters:

uiModificationId - The ID of the UI modification. (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>

getUiModifications

public io.reactivex.Single<PageBeanUiModificationDetails> getUiModifications(Optional<Long> startAt,
                                                                             Optional<Integer> maxResults,
                                                                             Optional<String> expand,
                                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get UI modifications Gets UI modifications. UI modifications can only be retrieved by Forge apps. **[Permissions](#permissions) required:** None.

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

expand - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `data` Returns UI modification data. * `contexts` Returns UI modification contexts. (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<PageBeanUiModificationDetails>

updateUiModification

public io.reactivex.Single<Object> updateUiModification(String uiModificationId,
                                                        UpdateUiModificationDetails updateUiModificationDetails,
                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update UI modification Updates a UI modification. UI modification can only be updated by Forge apps. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications. **[Permissions](#permissions) required:** * *None* if the UI modification is created without contexts. * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the UI modification is created with contexts.

Parameters:

uiModificationId - The ID of the UI modification. (required)

updateUiModificationDetails - Details of the UI modification. (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>