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

Class IssueCustomFieldOptionsApi

java.lang.Object

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

public class IssueCustomFieldOptionsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Object>	createCustomFieldOptions(Long fieldId, BulkCreateCustomFieldOptionRequest bulkCreateCustomFieldOptionRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create custom field options Creates options and, where the custom select field is of the type *Select List (cascading)*, cascading options for a custom select field.
io.reactivex.Completable	deleteCustomFieldOption(String fieldId, Long contextId, Long optionId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete custom field option (context) Deletes a custom field option.
io.reactivex.Single<CustomFieldOption>	getCustomFieldOption(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get custom field option Returns a custom field option.
io.reactivex.Single<PageBeanCustomFieldContextOption>	getOptionsForContext(String fieldId, Long contextId, Optional<Long> optionId, Optional<Boolean> onlyOptions, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get options for field (context) Returns a [paginated](#pagination) list of all custom field option for a context.
io.reactivex.Single<PageBeanCustomFieldOptionDetails>	getOptionsForField(Long fieldId, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get options for field Returns a [paginated](#pagination) list of options and, where the custom select field is of the type *Select List (cascading)*, cascading options for custom select fields.
io.reactivex.Single<Object>	reorderCustomFieldOptions(String fieldId, Long contextId, OrderOfCustomFieldOptions orderOfCustomFieldOptions, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Reorder options (context) Changes the order of custom field options or cascading options in a context.
io.reactivex.Single<Object>	updateCustomFieldOptions(Long fieldId, UpdateCustomFieldOption updateCustomFieldOption, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update custom field options Updates the options on a custom select field.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueCustomFieldOptionsApi

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

Method Detail

createCustomFieldOptions

public io.reactivex.Single<Object> createCustomFieldOptions(Long fieldId,
                                                            BulkCreateCustomFieldOptionRequest bulkCreateCustomFieldOptionRequest,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create custom field options Creates options and, where the custom select field is of the type *Select List (cascading)*, cascading options for a custom select field. The options are added to the global context of the field. Note that this operation **only works for issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue field select list options created by Connect apps. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. Note: This is the numeric part of the of the field ID. For example, for a field with the ID *customfield\\_10075* use *10075*. (required)

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

deleteCustomFieldOption

public io.reactivex.Completable deleteCustomFieldOption(String fieldId,
                                                        Long contextId,
                                                        Long optionId,
                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete custom field option (context) Deletes a custom field option. Options with cascading options cannot be deleted without deleting the cascading options first. This operation works for custom field options created in Jira or the operations from this resource. **To work with issue field select list options created for Connect apps use the [Issue custom field options (apps)](#api-group-issue-custom-field-options--apps-) operations.** **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. IDs should be provided in the format *customfield\\_XXXXX*. (required)

contextId - The ID of the context from which an option should be deleted. (required)

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

getCustomFieldOption

public io.reactivex.Single<CustomFieldOption> getCustomFieldOption(String id,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get custom field option Returns a custom field option. For example, an option in a select list. Note that this operation **only works for issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue field select list options created by Connect apps. This operation can be accessed anonymously. **[Permissions](#permissions) required:** The custom field option is returned as follows: * if the user has the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * if the user has the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one project the custom field is used in, and the field is visible in at least one layout the user has permission to view.

Parameters:

id - The ID of the custom field option. (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<CustomFieldOption>

getOptionsForContext

public io.reactivex.Single<PageBeanCustomFieldContextOption> getOptionsForContext(String fieldId,
                                                                                  Long contextId,
                                                                                  Optional<Long> optionId,
                                                                                  Optional<Boolean> onlyOptions,
                                                                                  Optional<Long> startAt,
                                                                                  Optional<Integer> maxResults,
                                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get options for field (context) Returns a [paginated](#pagination) list of all custom field option for a context. Options are returned first then cascading options, in the order they display in Jira. This operation works for custom field options created in Jira or the operations from this resource. **To work with issue field select list options created for Connect apps use the [Issue custom field options (apps)](#api-group-issue-custom-field-options--apps-) operations.** **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. IDs should be provided in the format *customfield\\_XXXXX*. (required)

contextId - The ID of the context. (required)

optionId - The ID of the option. (optional)

onlyOptions - Whether only options are returned. (optional, default to false)

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

restRequestEnhancer -

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

Returns:

Single<PageBeanCustomFieldContextOption>

getOptionsForField

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

Get options for field Returns a [paginated](#pagination) list of options and, where the custom select field is of the type *Select List (cascading)*, cascading options for custom select fields. Cascading options are included in the item count when determining pagination. Only options from the global context are returned. Note that this operation **only works for issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue field select list options created by Connect apps. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. Note: This is the numeric part of the of the field ID. For example, for a field with the ID *customfield\\_10075* use *10075*. (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 1000)

restRequestEnhancer -

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

Returns:

Single<PageBeanCustomFieldOptionDetails>

reorderCustomFieldOptions

public io.reactivex.Single<Object> reorderCustomFieldOptions(String fieldId,
                                                             Long contextId,
                                                             OrderOfCustomFieldOptions orderOfCustomFieldOptions,
                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Reorder options (context) Changes the order of custom field options or cascading options in a context. This operation works for custom field options created in Jira or the operations from this resource. **To work with issue field select list options created for Connect apps use the [Issue custom field options (apps)](#api-group-issue-custom-field-options--apps-) operations.** **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. IDs should be provided in the format *customfield\\_XXXXX*. (required)

contextId - The ID of the context. (required)

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

updateCustomFieldOptions

public io.reactivex.Single<Object> updateCustomFieldOptions(Long fieldId,
                                                            UpdateCustomFieldOption updateCustomFieldOption,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update custom field options Updates the options on a custom select field. Where an updated option is in use on an issue, the value on the issue is also updated. Options that are not found are ignored. A maximum of 1000 options, including sub-options of *Select List (cascading)* fields, can be updated per request. The options are updated on the global context of the field. Note that this operation **only works for issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue field select list options created by Connect apps. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. Note: This is the numeric part of the of the field ID. For example, for a field with the ID *customfield\\_10075* use *10075*. (required)

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