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

Class IssueCustomFieldContextsApi

java.lang.Object

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

public class IssueCustomFieldContextsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Object>	addIssueTypesToContext(String fieldId, Long contextId, IssueTypeIDs issueTypeIDs, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add issue types to context Adds issue types to a custom field context, appending the issue types to the issue types list.
io.reactivex.Single<Object>	assignProjectsToCustomFieldContext(String fieldId, Long contextId, ProjectIds projectIds, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Assign custom field context to projects Assigns a custom field context to projects.
io.reactivex.Single<CreateCustomFieldContext>	createCustomFieldContext(String fieldId, CreateCustomFieldContext createCustomFieldContext, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create custom field context Creates a custom field context.
io.reactivex.Single<Object>	deleteCustomFieldContext(String fieldId, Long contextId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete custom field context Deletes a [ custom field context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).
io.reactivex.Single<PageBeanCustomFieldContext>	getContextsForField(String fieldId, Optional<Boolean> isAnyIssueType, Optional<Boolean> isGlobalContext, Optional<List<Long>> contextId, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get custom field contexts Returns a [paginated](#pagination) list of [ contexts](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html) for a custom field.
io.reactivex.Single<PageBeanContextForProjectAndIssueType>	getCustomFieldContextsForProjectsAndIssueTypes(String fieldId, ProjectIssueTypeMappings projectIssueTypeMappings, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get custom field contexts for projects and issue types Returns a [paginated](#pagination) list of project and issue type mappings and, for each mapping, the ID of a [custom field context](https://confluence.atlassian.com/x/k44fOw) that applies to the project and issue type.
io.reactivex.Single<PageBeanCustomFieldContextDefaultValue>	getDefaultValues(String fieldId, Optional<List<Long>> contextId, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get custom field contexts default values Returns a [paginated](#pagination) list of defaults for a custom field.
io.reactivex.Single<PageBeanIssueTypeToContextMapping>	getIssueTypeMappingsForContexts(String fieldId, Optional<List<Long>> contextId, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue types for custom field context Returns a [paginated](#pagination) list of context to issue type mappings for a custom field.
io.reactivex.Single<PageBeanCustomFieldContextProjectMapping>	getProjectContextMapping(String fieldId, Optional<List<Long>> contextId, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project mappings for custom field context Returns a [paginated](#pagination) list of context to project mappings for a custom field.
io.reactivex.Single<Object>	removeCustomFieldContextFromProjects(String fieldId, Long contextId, ProjectIds projectIds, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove custom field context from projects Removes a custom field context from projects.
io.reactivex.Single<Object>	removeIssueTypesFromContext(String fieldId, Long contextId, IssueTypeIDs issueTypeIDs, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove issue types from context Removes issue types from a custom field context.
io.reactivex.Single<Object>	setDefaultValues(String fieldId, CustomFieldContextDefaultValueUpdate customFieldContextDefaultValueUpdate, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set custom field contexts default values Sets default for contexts of a custom field.
io.reactivex.Single<Object>	updateCustomFieldContext(String fieldId, Long contextId, CustomFieldContextUpdateDetails customFieldContextUpdateDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update custom field context Updates a [ custom field context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueCustomFieldContextsApi

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

Method Detail

addIssueTypesToContext

public io.reactivex.Single<Object> addIssueTypesToContext(String fieldId,
                                                          Long contextId,
                                                          IssueTypeIDs issueTypeIDs,
                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add issue types to context Adds issue types to a custom field context, appending the issue types to the issue types list. A custom field context without any issue types applies to all issue types. Adding issue types to such a custom field context would result in it applying to only the listed issue types. If any of the issue types exists in the custom field context, the operation fails and no issue types are added. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. (required)

contextId - The ID of the context. (required)

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

assignProjectsToCustomFieldContext

public io.reactivex.Single<Object> assignProjectsToCustomFieldContext(String fieldId,
                                                                      Long contextId,
                                                                      ProjectIds projectIds,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Assign custom field context to projects Assigns a custom field context to projects. If any project in the request is assigned to any context of the custom field, the operation fails. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. (required)

contextId - The ID of the context. (required)

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

createCustomFieldContext

public io.reactivex.Single<CreateCustomFieldContext> createCustomFieldContext(String fieldId,
                                                                              CreateCustomFieldContext createCustomFieldContext,
                                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create custom field context Creates a custom field context. If `projectIds` is empty, a global context is created. A global context is one that applies to all project. If `issueTypeIds` is empty, the context applies to all issue types. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. (required)

createCustomFieldContext - (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<CreateCustomFieldContext>

deleteCustomFieldContext

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

Delete custom field context Deletes a [ custom field context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. (required)

contextId - The ID of the context. (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>

getContextsForField

public io.reactivex.Single<PageBeanCustomFieldContext> getContextsForField(String fieldId,
                                                                           Optional<Boolean> isAnyIssueType,
                                                                           Optional<Boolean> isGlobalContext,
                                                                           Optional<List<Long>> contextId,
                                                                           Optional<Long> startAt,
                                                                           Optional<Integer> maxResults,
                                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get custom field contexts Returns a [paginated](#pagination) list of [ contexts](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html) for a custom field. Contexts can be returned as follows: * With no other parameters set, all contexts. * By defining `id` only, all contexts from the list of IDs. * By defining `isAnyIssueType`, limit the list of contexts returned to either those that apply to all issue types (true) or those that apply to only a subset of issue types (false) * By defining `isGlobalContext`, limit the list of contexts return to either those that apply to all projects (global contexts) (true) or those that apply to only a subset of projects (false). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. (required)

isAnyIssueType - Whether to return contexts that apply to all issue types. (optional)

isGlobalContext - Whether to return contexts that apply to all projects. (optional)

contextId - The list of context IDs. To include multiple contexts, separate IDs with ampersand: `contextId=10000&contextId=10001`. (optional, default to new ArrayList<>())

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

getCustomFieldContextsForProjectsAndIssueTypes

public io.reactivex.Single<PageBeanContextForProjectAndIssueType> getCustomFieldContextsForProjectsAndIssueTypes(String fieldId,
                                                                                                                 ProjectIssueTypeMappings projectIssueTypeMappings,
                                                                                                                 Optional<Long> startAt,
                                                                                                                 Optional<Integer> maxResults,
                                                                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get custom field contexts for projects and issue types Returns a [paginated](#pagination) list of project and issue type mappings and, for each mapping, the ID of a [custom field context](https://confluence.atlassian.com/x/k44fOw) that applies to the project and issue type. If there is no custom field context assigned to the project then, if present, the custom field context that applies to all projects is returned if it also applies to the issue type or all issue types. If a custom field context is not found, the returned custom field context ID is `null`. Duplicate project and issue type mappings cannot be provided in the request. The order of the returned values is the same as provided in the request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. (required)

projectIssueTypeMappings - The list of project and issue type mappings. (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<PageBeanContextForProjectAndIssueType>

getDefaultValues

public io.reactivex.Single<PageBeanCustomFieldContextDefaultValue> getDefaultValues(String fieldId,
                                                                                    Optional<List<Long>> contextId,
                                                                                    Optional<Long> startAt,
                                                                                    Optional<Integer> maxResults,
                                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get custom field contexts default values Returns a [paginated](#pagination) list of defaults for a custom field. The results can be filtered by `contextId`, otherwise all values are returned. If no defaults are set for a context, nothing is returned. The returned object depends on type of the custom field: * `CustomFieldContextDefaultValueSingleOption` (type `option.single`) for single choice select lists and radio buttons. * `CustomFieldContextDefaultValueMultipleOption` (type `option.multiple`) for multiple choice select lists and checkboxes. * `CustomFieldContextDefaultValueCascadingOption` (type `option.cascading`) for cascading select lists. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field, for example `customfield\\_10000`. (required)

contextId - The IDs of the contexts. (optional, default to new ArrayList<>())

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

getIssueTypeMappingsForContexts

public io.reactivex.Single<PageBeanIssueTypeToContextMapping> getIssueTypeMappingsForContexts(String fieldId,
                                                                                              Optional<List<Long>> contextId,
                                                                                              Optional<Long> startAt,
                                                                                              Optional<Integer> maxResults,
                                                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue types for custom field context Returns a [paginated](#pagination) list of context to issue type mappings for a custom field. Mappings are returned for all contexts or a list of contexts. Mappings are ordered first by context ID and then by issue type ID. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. (required)

contextId - The ID of the context. To include multiple contexts, provide an ampersand-separated list. For example, `contextId=10001&contextId=10002`. (optional, default to new ArrayList<>())

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

getProjectContextMapping

public io.reactivex.Single<PageBeanCustomFieldContextProjectMapping> getProjectContextMapping(String fieldId,
                                                                                              Optional<List<Long>> contextId,
                                                                                              Optional<Long> startAt,
                                                                                              Optional<Integer> maxResults,
                                                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project mappings for custom field context Returns a [paginated](#pagination) list of context to project mappings for a custom field. The result can be filtered by `contextId`. Otherwise, all mappings are returned. Invalid IDs are ignored. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field, for example `customfield\\_10000`. (required)

contextId - The list of context IDs. To include multiple context, separate IDs with ampersand: `contextId=10000&contextId=10001`. (optional, default to new ArrayList<>())

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

removeCustomFieldContextFromProjects

public io.reactivex.Single<Object> removeCustomFieldContextFromProjects(String fieldId,
                                                                        Long contextId,
                                                                        ProjectIds projectIds,
                                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove custom field context from projects Removes a custom field context from projects. A custom field context without any projects applies to all projects. Removing all projects from a custom field context would result in it applying to all projects. If any project in the request is not assigned to the context, or the operation would result in two global contexts for the field, the operation fails. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. (required)

contextId - The ID of the context. (required)

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

removeIssueTypesFromContext

public io.reactivex.Single<Object> removeIssueTypesFromContext(String fieldId,
                                                               Long contextId,
                                                               IssueTypeIDs issueTypeIDs,
                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove issue types from context Removes issue types from a custom field context. A custom field context without any issue types applies to all issue types. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. (required)

contextId - The ID of the context. (required)

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

setDefaultValues

public io.reactivex.Single<Object> setDefaultValues(String fieldId,
                                                    CustomFieldContextDefaultValueUpdate customFieldContextDefaultValueUpdate,
                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set custom field contexts default values Sets default for contexts of a custom field. Default are defined using these objects: * `CustomFieldContextDefaultValueSingleOption` (type `option.single`) for single choice select lists and radio buttons. * `CustomFieldContextDefaultValueMultipleOption` (type `option.multiple`) for multiple choice select lists and checkboxes. * `CustomFieldContextDefaultValueCascadingOption` (type `option.cascading`) for cascading select lists. Only one type of default object can be included in a request. To remove a default for a context, set the default parameter to `null`. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. (required)

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

updateCustomFieldContext

public io.reactivex.Single<Object> updateCustomFieldContext(String fieldId,
                                                            Long contextId,
                                                            CustomFieldContextUpdateDetails customFieldContextUpdateDetails,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update custom field context Updates a [ custom field context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldId - The ID of the custom field. (required)

contextId - The ID of the context. (required)

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