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

Class IssueTypeApi

java.lang.Object

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

public class IssueTypeApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<IssueTypeBean>	createIssueType(IssueTypeCreateBean issueTypeCreateBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create issue type Creates an issue type and adds it to the default issue type scheme.
io.reactivex.Single<Avatar>	createIssueTypeAvatar(String id, Object body, Optional<Integer> x, Optional<Integer> y, Optional<Integer> size, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Load issue type avatar Loads an avatar for the issue type.
io.reactivex.Completable	deleteIssueType(String id, Optional<String> alternativeIssueTypeId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete issue type Deletes the issue type.
io.reactivex.Single<List<IssueTypeBean>>	getAlternativeIssueTypes(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get alternative issue types Returns a list of issue types that can be used to replace the issue type.
io.reactivex.Single<List<IssueTypeBean>>	getIssueAllTypes(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all issue types for user Returns all issue types.
io.reactivex.Single<IssueTypeBean>	getIssueType(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue type Returns an issue type.
io.reactivex.Single<IssueTypeBean>	updateIssueType(String id, IssueTypeUpdateBean issueTypeUpdateBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update issue type Updates the issue type.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueTypeApi

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

Method Detail

createIssueType

public io.reactivex.Single<IssueTypeBean> createIssueType(IssueTypeCreateBean issueTypeCreateBean,
                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create issue type

Creates an issue type and adds it to the default issue type scheme.

Permissions required: Administer Jira global permission.

Parameters:

issueTypeCreateBean - (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<IssueTypeBean>

createIssueTypeAvatar

public io.reactivex.Single<Avatar> createIssueTypeAvatar(String id,
                                                         Object body,
                                                         Optional<Integer> x,
                                                         Optional<Integer> y,
                                                         Optional<Integer> size,
                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Load issue type avatar

Loads an avatar for the issue type.

Specify the avatar's local file location in the body of the request. Also, include the following headers:

• X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.
• Content-Type: image/image type Valid image types are JPEG, GIF, or PNG.

For example:
curl --request POST \\ --user email@example.com:<api_token> \\ --header 'X-Atlassian-Token: no-check' \\ --header 'Content-Type: image/< image_type>' \\ --data-binary "<@/path/to/file/with/your/avatar>" \\ --url 'https://your-domain.atlassian.net/rest/api/2/issuetype/{issueTypeId}'This

The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

After creating the avatar, use Update issue type to set it as the issue type's displayed avatar.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the issue type.

(required)

body - (required)

x -

The X coordinate of the top-left corner of the crop region.

(optional, default to 0)

y -

The Y coordinate of the top-left corner of the crop region.

(optional, default to 0)

size -

The length of each side of the crop region.

(optional)

restRequestEnhancer -

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

Returns:

Single<Avatar>

deleteIssueType

public io.reactivex.Completable deleteIssueType(String id,
                                                Optional<String> alternativeIssueTypeId,
                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete issue type

Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (alternativeIssueTypeId). A list of alternative issue types are obtained from the Get alternative issue types resource.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the issue type.

(required)

alternativeIssueTypeId -

The ID of the replacement issue type.

(optional)

restRequestEnhancer -

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

Returns:

Completable

getAlternativeIssueTypes

public io.reactivex.Single<List<IssueTypeBean>> getAlternativeIssueTypes(String id,
                                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get alternative issue types

Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.

This operation can be accessed anonymously.

Permissions required: None.

Parameters:

id -

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

getIssueAllTypes

public io.reactivex.Single<List<IssueTypeBean>> getIssueAllTypes(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all issue types for user

Returns all issue types.

This operation can be accessed anonymously.

Permissions required: Issue types are only returned as follows:

• if the user has the Administer Jira global permission, all issue types are returned.
• if the user has the Browse projects project permission for one or more projects, the issue types associated with the projects the user has permission to browse are returned.

Parameters:

restRequestEnhancer -

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

Returns:

Single<List<IssueTypeBean>>

getIssueType

public io.reactivex.Single<IssueTypeBean> getIssueType(String id,
                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue type

Returns an issue type.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission in a project the issue type is associated with or Administer Jira global permission.

Parameters:

id -

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

updateIssueType

public io.reactivex.Single<IssueTypeBean> updateIssueType(String id,
                                                          IssueTypeUpdateBean issueTypeUpdateBean,
                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update issue type

Updates the issue type.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the issue type.

(required)

issueTypeUpdateBean - (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<IssueTypeBean>