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

Class IssuePropertyApi

java.lang.Object

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

public class IssuePropertyApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	deleteIssueProperty(String issueIdOrKey, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete issue property Deletes an issue's property.
io.reactivex.Single<EntityProperty>	getIssueProperty(String issueIdOrKey, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue property Returns the key and value of an issue's property.
io.reactivex.Single<PropertyKeys>	getIssuePropertyKeys(String issueIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue property keys Returns the URLs and keys of an issue's properties.
io.reactivex.Single<Object>	setIssueProperty(String issueIdOrKey, String propertyKey, Object body, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set issue property Sets the value of an issue's property.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssuePropertyApi

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

Method Detail

deleteIssueProperty

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

Delete issue property

Deletes an issue's property.

This operation can be accessed anonymously.

Permissions required:

• Browse projects and Edit issues project permissions for the project containing the issue.
• If issue-level security is configured, issue-level security permission to view the issue.

Parameters:

issueIdOrKey -

The key or ID of the issue.

(required)

propertyKey -

The key of the property.

(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

getIssueProperty

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

Get issue property

Returns the key and value of an issue's property.

This operation can be accessed anonymously.

Permissions required:

• Browse projects project permission for the project containing the issue.
• If issue-level security is configured, issue-level security permission to view the issue.

Parameters:

issueIdOrKey -

The key or ID of the issue.

(required)

propertyKey -

The key of the property.

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

getIssuePropertyKeys

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

Get issue property keys

Returns the URLs and keys of an issue's properties.

This operation can be accessed anonymously.

Permissions required: Property details are only returned where the user has:

• Browse projects project permission for the project containing the issue.
• If issue-level security is configured, issue-level security permission to view the issue.

Parameters:

issueIdOrKey -

The key or ID of the issue.

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

setIssueProperty

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

Set issue property

Sets the value of an issue's property. Use this resource to store custom data against an issue.

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

This operation can be accessed anonymously.

Permissions required:

• Browse projects and Edit issues project permissions for the project containing the issue.
• If issue-level security is configured, issue-level security permission to view the issue.

Parameters:

issueIdOrKey -

The ID or key of the issue.

(required)

propertyKey -

The key of the issue 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>