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

Class IssueTypeSchemesApi

java.lang.Object

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

public class IssueTypeSchemesApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Object>	addIssueTypesToIssueTypeScheme(Long issueTypeSchemeId, IssueTypeIDs issueTypeIDs, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add issue types to issue type scheme Adds issue types to an issue type scheme.
io.reactivex.Single<Object>	assignIssueTypeSchemeToProject(IssueTypeSchemeProjectAssociation issueTypeSchemeProjectAssociation, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Assign issue type scheme to project Assigns an issue type scheme to a project.
io.reactivex.Single<IssueTypeSchemeID>	createIssueTypeScheme(IssueTypeSchemeDetails issueTypeSchemeDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create issue type scheme Creates an issue type scheme.
io.reactivex.Single<Object>	deleteIssueTypeScheme(Long issueTypeSchemeId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete issue type scheme Deletes an issue type scheme.
io.reactivex.Single<PageBeanIssueTypeScheme>	getAllIssueTypeSchemes(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<Long>> id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all issue type schemes Returns a [paginated](#pagination) list of issue type schemes.
io.reactivex.Single<PageBeanIssueTypeSchemeProjects>	getIssueTypeSchemeForProjects(List<Long> projectId, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue type schemes for projects Returns a [paginated](#pagination) list of issue type schemes and, for each issue type scheme, a list of the projects that use it.
io.reactivex.Single<PageBeanIssueTypeSchemeMapping>	getIssueTypeSchemesMapping(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<Long>> issueTypeSchemeId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue type scheme items Returns a [paginated](#pagination) list of issue type scheme items.
io.reactivex.Single<Object>	removeIssueTypeFromIssueTypeScheme(Long issueTypeSchemeId, Long issueTypeId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Remove issue type from issue type scheme Removes an issue type from an issue type scheme.
io.reactivex.Single<Object>	reorderIssueTypesInIssueTypeScheme(Long issueTypeSchemeId, OrderOfIssueTypes orderOfIssueTypes, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Change order of issue types Changes the order of issue types in an issue type scheme.
io.reactivex.Single<Object>	updateIssueTypeScheme(Long issueTypeSchemeId, IssueTypeSchemeUpdateDetails issueTypeSchemeUpdateDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update issue type scheme Updates an issue type scheme.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueTypeSchemesApi

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

Method Detail

addIssueTypesToIssueTypeScheme

public io.reactivex.Single<Object> addIssueTypesToIssueTypeScheme(Long issueTypeSchemeId,
                                                                  IssueTypeIDs issueTypeIDs,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add issue types to issue type scheme Adds issue types to an issue type scheme. The added issue types are appended to the issue types list. If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

issueTypeSchemeId - The ID of the issue type scheme. (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>

assignIssueTypeSchemeToProject

public io.reactivex.Single<Object> assignIssueTypeSchemeToProject(IssueTypeSchemeProjectAssociation issueTypeSchemeProjectAssociation,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Assign issue type scheme to project Assigns an issue type scheme to a project. If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme. Issue type schemes can only be assigned to classic projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

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

createIssueTypeScheme

public io.reactivex.Single<IssueTypeSchemeID> createIssueTypeScheme(IssueTypeSchemeDetails issueTypeSchemeDetails,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create issue type scheme Creates an issue type scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

issueTypeSchemeDetails - (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<IssueTypeSchemeID>

deleteIssueTypeScheme

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

Delete issue type scheme Deletes an issue type scheme. Only issue type schemes used in classic projects can be deleted. Any projects assigned to the scheme are reassigned to the default issue type scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

issueTypeSchemeId - The ID of the issue type 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>

getAllIssueTypeSchemes

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

Get all issue type schemes Returns a [paginated](#pagination) list of issue type schemes. Only issue type 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 issue type schemes 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<PageBeanIssueTypeScheme>

getIssueTypeSchemeForProjects

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

Get issue type schemes for projects Returns a [paginated](#pagination) list of issue type schemes and, for each issue type scheme, a list of the projects that use it. Only issue type 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 project IDs, provide an ampersand-separated list. For example, `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<PageBeanIssueTypeSchemeProjects>

getIssueTypeSchemesMapping

public io.reactivex.Single<PageBeanIssueTypeSchemeMapping> getIssueTypeSchemesMapping(Optional<Long> startAt,
                                                                                      Optional<Integer> maxResults,
                                                                                      Optional<List<Long>> issueTypeSchemeId,
                                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue type scheme items Returns a [paginated](#pagination) list of issue type scheme items. Only issue type scheme 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)

issueTypeSchemeId - The list of issue type scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `issueTypeSchemeId=10000&issueTypeSchemeId=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<PageBeanIssueTypeSchemeMapping>

removeIssueTypeFromIssueTypeScheme

public io.reactivex.Single<Object> removeIssueTypeFromIssueTypeScheme(Long issueTypeSchemeId,
                                                                      Long issueTypeId,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Remove issue type from issue type scheme Removes an issue type from an issue type scheme. This operation cannot remove: * any issue type used by issues. * any issue types from the default issue type scheme. * the last standard issue type from an issue type scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

issueTypeSchemeId - The ID of the issue type scheme. (required)

issueTypeId - The ID of the issue type. (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>

reorderIssueTypesInIssueTypeScheme

public io.reactivex.Single<Object> reorderIssueTypesInIssueTypeScheme(Long issueTypeSchemeId,
                                                                      OrderOfIssueTypes orderOfIssueTypes,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Change order of issue types Changes the order of issue types in an issue type scheme. The request body parameters must meet the following requirements: * all of the issue types must belong to the issue type scheme. * either `after` or `position` must be provided. * the issue type in `after` must not be in the issue type list. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

issueTypeSchemeId - The ID of the issue type scheme. (required)

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

updateIssueTypeScheme

public io.reactivex.Single<Object> updateIssueTypeScheme(Long issueTypeSchemeId,
                                                         IssueTypeSchemeUpdateDetails issueTypeSchemeUpdateDetails,
                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update issue type scheme Updates an issue type scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

issueTypeSchemeId - The ID of the issue type scheme. (required)

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