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<PageBeanFieldConfiguration>	getAllFieldConfigurations(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<Long>> id, Optional<Boolean> isDefault, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all field configurations Returns a [paginated](#pagination) list of all 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.

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>

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<PageBeanFieldConfiguration> getAllFieldConfigurations(Optional<Long> startAt,
                                                                                 Optional<Integer> maxResults,
                                                                                 Optional<List<Long>> id,
                                                                                 Optional<Boolean> isDefault,
                                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all field configurations Returns a [paginated](#pagination) list of all field configurations. Only field configurations 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 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 the default field configuration only. (optional, default to false)

restRequestEnhancer -

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

Returns:

Single<PageBeanFieldConfiguration>

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