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

Class IssueWorklogPropertiesApi

java.lang.Object

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

public class IssueWorklogPropertiesApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	deleteWorklogProperty(String issueIdOrKey, String worklogId, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete worklog property Deletes a worklog property.
io.reactivex.Single<EntityProperty>	getWorklogProperty(String issueIdOrKey, String worklogId, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get worklog property Returns the value of a worklog property.
io.reactivex.Single<PropertyKeys>	getWorklogPropertyKeys(String issueIdOrKey, String worklogId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get worklog property keys Returns the keys of all properties for a worklog.
io.reactivex.Single<Object>	setWorklogProperty(String issueIdOrKey, String worklogId, String propertyKey, Object body, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set worklog property Sets the value of a worklog property.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueWorklogPropertiesApi

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

Method Detail

deleteWorklogProperty

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

Delete worklog property Deletes a worklog property. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters:

issueIdOrKey - The ID or key of the issue. (required)

worklogId - The ID of the worklog. (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

getWorklogProperty

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

Get worklog property Returns the value of a worklog property. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters:

issueIdOrKey - The ID or key of the issue. (required)

worklogId - The ID of the worklog. (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>

getWorklogPropertyKeys

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

Get worklog property keys Returns the keys of all properties for a worklog. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters:

issueIdOrKey - The ID or key of the issue. (required)

worklogId - The ID of the worklog. (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>

setWorklogProperty

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

Set worklog property Sets the value of a worklog property. Use this operation to store custom data against the worklog. The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * *Edit all worklogs*[ project permission](https://confluence.atlassian.com/x/yodKLg) to update any worklog or *Edit own worklogs* to update worklogs created by the user. * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters:

issueIdOrKey - The ID or key of the issue. (required)

worklogId - The ID of the worklog. (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>