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

Class IssueFieldConfigurationsApi

java.lang.Object

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

public class IssueFieldConfigurationsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Object>	assignFieldConfigurationSchemeToProject(FieldConfigurationSchemeProjectAssociation fieldConfigurationSchemeProjectAssociation, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Assign field configuration scheme to project Assigns a field configuration scheme to a project.
io.reactivex.Single<FieldConfiguration>	createFieldConfiguration(FieldConfigurationDetails fieldConfigurationDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create field configuration Creates a field configuration.
io.reactivex.Single<FieldConfigurationScheme>	createFieldConfigurationScheme(UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create field configuration scheme Creates a field configuration scheme.
io.reactivex.Single<Object>	deleteFieldConfiguration(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete field configuration Deletes a field configuration.
io.reactivex.Single<Object>	deleteFieldConfigurationScheme(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete field configuration scheme Deletes a field configuration scheme.
io.reactivex.Single<PageBeanFieldConfigurationDetails>	getAllFieldConfigurations(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<Long>> id, Optional<Boolean> isDefault, Optional<String> query, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all field configurations Returns a [paginated](#pagination) list of field configurations.
io.reactivex.Single<PageBeanFieldConfigurationScheme>	getAllFieldConfigurationSchemes(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<Long>> id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all field configuration schemes Returns a [paginated](#pagination) list of field configuration schemes.
io.reactivex.Single<PageBeanFieldConfigurationItem>	getFieldConfigurationItems(Long id, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get field configuration items Returns a [paginated](#pagination) list of all fields for a configuration.
io.reactivex.Single<PageBeanFieldConfigurationIssueTypeItem>	getFieldConfigurationSchemeMappings(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<Long>> fieldConfigurationSchemeId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get field configuration issue type items Returns a [paginated](#pagination) list of field configuration issue type items.
io.reactivex.Single<PageBeanFieldConfigurationSchemeProjects>	getFieldConfigurationSchemeProjectMapping(List<Long> projectId, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get field configuration schemes for projects Returns a [paginated](#pagination) list of field configuration schemes and, for each scheme, a list of the projects that use it.
io.reactivex.Single<Object>	removeIssueTypesFromGlobalFieldConfigurationScheme(Long id, IssueTypeIdsToRemove issueTypeIdsToRemove, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove issue types from field configuration scheme Removes issue types from the field configuration scheme.
io.reactivex.Single<Object>	setFieldConfigurationSchemeMapping(Long id, AssociateFieldConfigurationsWithIssueTypesRequest associateFieldConfigurationsWithIssueTypesRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Assign issue types to field configurations Assigns issue types to field configurations on field configuration scheme.
io.reactivex.Single<Object>	updateFieldConfiguration(Long id, FieldConfigurationDetails fieldConfigurationDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update field configuration Updates a field configuration.
io.reactivex.Single<Object>	updateFieldConfigurationItems(Long id, FieldConfigurationItemsDetails fieldConfigurationItemsDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update field configuration items Updates fields in a field configuration.
io.reactivex.Single<Object>	updateFieldConfigurationScheme(Long id, UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update field configuration scheme Updates a field configuration scheme.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueFieldConfigurationsApi

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

Method Detail

assignFieldConfigurationSchemeToProject

public io.reactivex.Single<Object> assignFieldConfigurationSchemeToProject(FieldConfigurationSchemeProjectAssociation fieldConfigurationSchemeProjectAssociation,
                                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Assign field configuration scheme to project Assigns a field configuration scheme to a project. If the field configuration scheme ID is `null`, the operation assigns the default field configuration scheme. Field configuration schemes can only be assigned to classic projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

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

createFieldConfiguration

public io.reactivex.Single<FieldConfiguration> createFieldConfiguration(FieldConfigurationDetails fieldConfigurationDetails,
                                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create field configuration Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional. This operation can only create configurations for use in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

fieldConfigurationDetails - (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<FieldConfiguration>

createFieldConfigurationScheme

public io.reactivex.Single<FieldConfigurationScheme> createFieldConfigurationScheme(UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails,
                                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create field configuration scheme Creates a field configuration scheme. This operation can only create field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

updateFieldConfigurationSchemeDetails - The details of the field configuration scheme. (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<FieldConfigurationScheme>

deleteFieldConfiguration

public io.reactivex.Single<Object> deleteFieldConfiguration(Long id,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete field configuration Deletes a field configuration. This operation can only delete configurations used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

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

deleteFieldConfigurationScheme

public io.reactivex.Single<Object> deleteFieldConfigurationScheme(Long id,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete field configuration scheme Deletes a field configuration scheme. This operation can only delete field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the field configuration scheme. (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>

getAllFieldConfigurationSchemes

public io.reactivex.Single<PageBeanFieldConfigurationScheme> getAllFieldConfigurationSchemes(Optional<Long> startAt,
                                                                                             Optional<Integer> maxResults,
                                                                                             Optional<List<Long>> id,
                                                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all field configuration schemes Returns a [paginated](#pagination) list of field configuration schemes. Only field configuration schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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)

id - The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (optional, default to new ArrayList<>())

restRequestEnhancer -

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

Returns:

Single<PageBeanFieldConfigurationScheme>

getAllFieldConfigurations

public io.reactivex.Single<PageBeanFieldConfigurationDetails> getAllFieldConfigurations(Optional<Long> startAt,
                                                                                        Optional<Integer> maxResults,
                                                                                        Optional<List<Long>> id,
                                                                                        Optional<Boolean> isDefault,
                                                                                        Optional<String> query,
                                                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all field configurations Returns a [paginated](#pagination) list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria: * a list of field configuration item IDs. * whether the field configuration is a default. * whether the field configuration name or description contains a query string. Only field configurations used in company-managed (classic) projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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)

id - The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (optional, default to new ArrayList<>())

isDefault - If *true* returns default field configurations only. (optional, default to false)

query - The query string used to match against field configuration names and descriptions. (optional, default to "")

restRequestEnhancer -

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

Returns:

Single<PageBeanFieldConfigurationDetails>

getFieldConfigurationItems

public io.reactivex.Single<PageBeanFieldConfigurationItem> getFieldConfigurationItems(Long id,
                                                                                      Optional<Long> startAt,
                                                                                      Optional<Integer> maxResults,
                                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get field configuration items Returns a [paginated](#pagination) list of all fields for a configuration. Only the fields from configurations used in company-managed (classic) projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the field configuration. (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<PageBeanFieldConfigurationItem>

getFieldConfigurationSchemeMappings

public io.reactivex.Single<PageBeanFieldConfigurationIssueTypeItem> getFieldConfigurationSchemeMappings(Optional<Long> startAt,
                                                                                                        Optional<Integer> maxResults,
                                                                                                        Optional<List<Long>> fieldConfigurationSchemeId,
                                                                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get field configuration issue type items Returns a [paginated](#pagination) list of field configuration issue type items. Only items used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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)

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

restRequestEnhancer -

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

Returns:

Single<PageBeanFieldConfigurationIssueTypeItem>

getFieldConfigurationSchemeProjectMapping

public io.reactivex.Single<PageBeanFieldConfigurationSchemeProjects> getFieldConfigurationSchemeProjectMapping(List<Long> projectId,
                                                                                                               Optional<Long> startAt,
                                                                                                               Optional<Integer> maxResults,
                                                                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get field configuration schemes for projects Returns a [paginated](#pagination) list of field configuration schemes and, for each scheme, a list of the projects that use it. The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme. Only field configuration schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

projectId - The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`. (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<PageBeanFieldConfigurationSchemeProjects>

removeIssueTypesFromGlobalFieldConfigurationScheme

public io.reactivex.Single<Object> removeIssueTypesFromGlobalFieldConfigurationScheme(Long id,
                                                                                      IssueTypeIdsToRemove issueTypeIdsToRemove,
                                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove issue types from field configuration scheme Removes issue types from the field configuration scheme. This operation can only modify field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the field configuration scheme. (required)

issueTypeIdsToRemove - The issue type IDs to remove. (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>

setFieldConfigurationSchemeMapping

public io.reactivex.Single<Object> setFieldConfigurationSchemeMapping(Long id,
                                                                      AssociateFieldConfigurationsWithIssueTypesRequest associateFieldConfigurationsWithIssueTypesRequest,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Assign issue types to field configurations Assigns issue types to field configurations on field configuration scheme. This operation can only modify field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the field configuration scheme. (required)

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

updateFieldConfiguration

public io.reactivex.Single<Object> updateFieldConfiguration(Long id,
                                                            FieldConfigurationDetails fieldConfigurationDetails,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update field configuration Updates a field configuration. The name and the description provided in the request override the existing values. This operation can only update configurations used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the field configuration. (required)

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

updateFieldConfigurationItems

public io.reactivex.Single<Object> updateFieldConfigurationItems(Long id,
                                                                 FieldConfigurationItemsDetails fieldConfigurationItemsDetails,
                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update field configuration items Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values. This operation can only update field configurations used in company-managed (classic) projects. The operation can set the renderer for text fields to the default text renderer (`text-renderer`) or wiki style renderer (`wiki-renderer`). However, the renderer cannot be updated for fields using the autocomplete renderer (`autocomplete-renderer`). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the field configuration. (required)

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

updateFieldConfigurationScheme

public io.reactivex.Single<Object> updateFieldConfigurationScheme(Long id,
                                                                  UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update field configuration scheme Updates a field configuration scheme. This operation can only update field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the field configuration scheme. (required)

updateFieldConfigurationSchemeDetails - The details of the field configuration scheme. (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>