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

Class IssueTypePropertyApi

java.lang.Object

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

public class IssueTypePropertyApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	deleteIssueTypeProperty(String issueTypeId, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete issue type property Deletes the issue type property.
io.reactivex.Single<EntityProperty>	getIssueTypeProperty(String issueTypeId, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue type property Returns the key and value of the issue type property.
io.reactivex.Single<PropertyKeys>	getIssueTypePropertyKeys(String issueTypeId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue type property keys Returns all the issue type property keys of the issue type.
io.reactivex.Single<Object>	setIssueTypeProperty(String issueTypeId, String propertyKey, Object body, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set issue type property Creates or updates the value of the issue type property.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueTypePropertyApi

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

Method Detail

deleteIssueTypeProperty

public io.reactivex.Completable deleteIssueTypeProperty(String issueTypeId,
                                                        String propertyKey,
                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete issue type property

Deletes the issue type property.

Permissions required: Administer Jira global permission.

Parameters:

issueTypeId -

The ID of the issue type.

(required)

propertyKey -

The key of the property. Use Get issue type property keys to get a list of all issue type property keys.

(required)

restRequestEnhancer -

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

Returns:

Completable

getIssueTypeProperty

public io.reactivex.Single<EntityProperty> getIssueTypeProperty(String issueTypeId,
                                                                String propertyKey,
                                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue type property

Returns the key and value of the issue type property.

This operation can be accessed anonymously.

Permissions required:

• Administer Jira global permission to get the details of any issue type.
• Browse projects project permission to get the details of any issue types associated with the projects the user has permission to browse.

Parameters:

issueTypeId -

The ID of the issue type.

(required)

propertyKey -

The key of the property. Use Get issue type property keys to get a list of all issue type property keys.

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

getIssueTypePropertyKeys

public io.reactivex.Single<PropertyKeys> getIssueTypePropertyKeys(String issueTypeId,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue type property keys

Returns all the issue type property keys of the issue type.

This operation can be accessed anonymously.

Permissions required:

• Administer Jira global permission to get the property keys of any issue type.
• Browse projects project permission to get the property keys of any issue types associated with the projects the user has permission to browse.

Parameters:

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

setIssueTypeProperty

public io.reactivex.Single<Object> setIssueTypeProperty(String issueTypeId,
                                                        String propertyKey,
                                                        Object body,
                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set issue type property

Creates or updates the value of the issue type property. Use this resource to store and update data against an issue type.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: Administer Jira global permission.

Parameters:

issueTypeId -

The ID of the issue type.

(required)

propertyKey -

The key of the issue type property. The maximum length is 255 characters.

(required)

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