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

Class IssueCustomFieldConfigurationAppsApi

java.lang.Object

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

public class IssueCustomFieldConfigurationAppsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<PageBeanContextualConfiguration>	getCustomFieldConfiguration(String fieldIdOrKey, Optional<List<Long>> contextId, Optional<Long> issueId, Optional<String> projectKeyOrId, Optional<String> issueTypeId, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get custom field configurations Returns a [paginated](#pagination) list of configurations for a custom field created by a [Forge app](https://developer.atlassian.com/platform/forge/).
io.reactivex.Single<Object>	updateCustomFieldConfiguration(String fieldIdOrKey, CustomFieldConfigurations customFieldConfigurations, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update custom field configurations Update the configuration for contexts of a custom field created by a [Forge app](https://developer.atlassian.com/platform/forge/).

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueCustomFieldConfigurationAppsApi

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

Method Detail

getCustomFieldConfiguration

public io.reactivex.Single<PageBeanContextualConfiguration> getCustomFieldConfiguration(String fieldIdOrKey,
                                                                                        Optional<List<Long>> contextId,
                                                                                        Optional<Long> issueId,
                                                                                        Optional<String> projectKeyOrId,
                                                                                        Optional<String> issueTypeId,
                                                                                        Optional<Long> startAt,
                                                                                        Optional<Integer> maxResults,
                                                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get custom field configurations Returns a [paginated](#pagination) list of configurations for a custom field created by a [Forge app](https://developer.atlassian.com/platform/forge/). The result can be filtered by one of these criteria: * `contextId`. * `issueId`. * `projectKeyOrId` and `issueTypeId`. Otherwise, all configurations are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the Forge app that created the custom field.

Parameters:

fieldIdOrKey - The ID or key of the custom field, for example `customfield_10000`. (required)

contextId - The list of context IDs. To include multiple contexts, separate IDs with an ampersand: `contextId=10000&contextId=10001`. Can't be provided with `issueId`, `projectKeyOrId`, or `issueTypeId`. (optional, default to new ArrayList<>())

issueId - The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with `contextIds`, `projectKeyOrId`, or `issueTypeId`. (optional)

projectKeyOrId - The ID or key of the project to filter results by. Must be provided with `issueTypeId`. Can't be provided with `contextIds` or `issueId`. (optional)

issueTypeId - The ID of the issue type to filter results by. Must be provided with `projectKeyOrId`. Can't be provided with `contextIds` or `issueId`. (optional)

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<PageBeanContextualConfiguration>

updateCustomFieldConfiguration

public io.reactivex.Single<Object> updateCustomFieldConfiguration(String fieldIdOrKey,
                                                                  CustomFieldConfigurations customFieldConfigurations,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update custom field configurations Update the configuration for contexts of a custom field created by a [Forge app](https://developer.atlassian.com/platform/forge/). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the Forge app that created the custom field.

Parameters:

fieldIdOrKey - The ID or key of the custom field, for example `customfield_10000`. (required)

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