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

Class IssueCustomFieldOptionsAppsApi

java.lang.Object

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

public class IssueCustomFieldOptionsAppsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<IssueFieldOption>	createIssueFieldOption(String fieldKey, IssueFieldOptionCreateBean requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create issue field option Creates an option for a select list issue field.
io.reactivex.Single<Object>	deleteIssueFieldOption(String fieldKey, Long optionId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete issue field option Deletes an option from a select list issue field.
io.reactivex.Single<PageBeanIssueFieldOption>	getAllIssueFieldOptions(String fieldKey, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all issue field options Returns a [paginated](#pagination) list of all the options of a select list issue field.
io.reactivex.Single<IssueFieldOption>	getIssueFieldOption(String fieldKey, Long optionId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue field option Returns an option from a select list issue field.
io.reactivex.Single<PageBeanIssueFieldOption>	getSelectableIssueFieldOptions(String fieldKey, Optional<Long> startAt, Optional<Integer> maxResults, Optional<Long> projectId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get selectable issue field options Returns a [paginated](#pagination) list of options for a select list issue field that can be viewed and selected by the user.
io.reactivex.Single<PageBeanIssueFieldOption>	getVisibleIssueFieldOptions(String fieldKey, Optional<Long> startAt, Optional<Integer> maxResults, Optional<Long> projectId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get visible issue field options Returns a [paginated](#pagination) list of options for a select list issue field that can be viewed by the user.
io.reactivex.Completable	replaceIssueFieldOption(String fieldKey, Long optionId, Optional<Long> replaceWith, Optional<String> jql, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Replace issue field option Deselects an issue-field select-list option from all issues where it is selected.
io.reactivex.Single<IssueFieldOption>	updateIssueFieldOption(String fieldKey, Long optionId, IssueFieldOption issueFieldOption, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update issue field option Updates or creates an option for a select list issue field.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueCustomFieldOptionsAppsApi

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

Method Detail

createIssueFieldOption

public io.reactivex.Single<IssueFieldOption> createIssueFieldOption(String fieldKey,
                                                                    IssueFieldOptionCreateBean requestBody,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create issue field option Creates an option for a select list issue field. Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.

Parameters:

fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"` (required)

requestBody - (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<IssueFieldOption>

deleteIssueFieldOption

public io.reactivex.Single<Object> deleteIssueFieldOption(String fieldKey,
                                                          Long optionId,
                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete issue field option Deletes an option from a select list issue field. Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.

Parameters:

fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"` (required)

optionId - The ID of the option to be deleted. (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>

getAllIssueFieldOptions

public io.reactivex.Single<PageBeanIssueFieldOption> getAllIssueFieldOptions(String fieldKey,
                                                                             Optional<Long> startAt,
                                                                             Optional<Integer> maxResults,
                                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all issue field options Returns a [paginated](#pagination) list of all the options of a select list issue field. A select list issue field is a type of [issue field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/) that enables a user to select a value from a list of options. Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.

Parameters:

fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"` (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 50)

restRequestEnhancer -

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

Returns:

Single<PageBeanIssueFieldOption>

getIssueFieldOption

public io.reactivex.Single<IssueFieldOption> getIssueFieldOption(String fieldKey,
                                                                 Long optionId,
                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue field option Returns an option from a select list issue field. Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.

Parameters:

fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"` (required)

optionId - The ID of the option to be returned. (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<IssueFieldOption>

getSelectableIssueFieldOptions

public io.reactivex.Single<PageBeanIssueFieldOption> getSelectableIssueFieldOptions(String fieldKey,
                                                                                    Optional<Long> startAt,
                                                                                    Optional<Integer> maxResults,
                                                                                    Optional<Long> projectId,
                                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get selectable issue field options Returns a [paginated](#pagination) list of options for a select list issue field that can be viewed and selected by the user. Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"` (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 50)

projectId - Filters the results to options that are only available in the specified 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<PageBeanIssueFieldOption>

getVisibleIssueFieldOptions

public io.reactivex.Single<PageBeanIssueFieldOption> getVisibleIssueFieldOptions(String fieldKey,
                                                                                 Optional<Long> startAt,
                                                                                 Optional<Integer> maxResults,
                                                                                 Optional<Long> projectId,
                                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get visible issue field options Returns a [paginated](#pagination) list of options for a select list issue field that can be viewed by the user. Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"` (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)

projectId - Filters the results to options that are only available in the specified 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<PageBeanIssueFieldOption>

replaceIssueFieldOption

public io.reactivex.Completable replaceIssueFieldOption(String fieldKey,
                                                        Long optionId,
                                                        Optional<Long> replaceWith,
                                                        Optional<String> jql,
                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Replace issue field option Deselects an issue-field select-list option from all issues where it is selected. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query. This is an [asynchronous operation](#async). The response object contains a link to the long-running task. Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.

Parameters:

fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"` (required)

optionId - The ID of the option to be deselected. (required)

replaceWith - The ID of the option that will replace the currently selected option. (optional)

jql - A JQL query that specifies the issues to be updated. For example, *project=10000*. (optional)

restRequestEnhancer -

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

Returns:

Completable

updateIssueFieldOption

public io.reactivex.Single<IssueFieldOption> updateIssueFieldOption(String fieldKey,
                                                                    Long optionId,
                                                                    IssueFieldOption issueFieldOption,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update issue field option Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical. Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.

Parameters:

fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"` (required)

optionId - The ID of the option to be updated. (required)

issueFieldOption - (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<IssueFieldOption>