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

Class IssueWorklogsApi

java.lang.Object

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

public class IssueWorklogsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Worklog>	addWorklog(String issueIdOrKey, Worklog requestBody, Optional<Boolean> notifyUsers, Optional<String> adjustEstimate, Optional<String> newEstimate, Optional<String> reduceBy, Optional<String> expand, Optional<Boolean> overrideEditableFlag, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add worklog Adds a worklog to an issue.
io.reactivex.Completable	deleteWorklog(String issueIdOrKey, String id, Optional<Boolean> notifyUsers, Optional<String> adjustEstimate, Optional<String> newEstimate, Optional<String> increaseBy, Optional<Boolean> overrideEditableFlag, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete worklog Deletes a worklog from an issue.
io.reactivex.Single<PageOfWorklogs>	getIssueWorklog(String issueIdOrKey, Optional<Long> startAt, Optional<Integer> maxResults, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue worklogs Returns all worklogs for an issue.
io.reactivex.Single<Worklog>	getWorklog(String issueIdOrKey, String id, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get worklog Returns a worklog.
io.reactivex.Single<Worklog>	updateWorklog(String issueIdOrKey, String id, Worklog requestBody, Optional<Boolean> notifyUsers, Optional<String> adjustEstimate, Optional<String> newEstimate, Optional<String> expand, Optional<Boolean> overrideEditableFlag, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update worklog Updates a worklog.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueWorklogsApi

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

Method Detail

addWorklog

public io.reactivex.Single<Worklog> addWorklog(String issueIdOrKey,
                                               Worklog requestBody,
                                               Optional<Boolean> notifyUsers,
                                               Optional<String> adjustEstimate,
                                               Optional<String> newEstimate,
                                               Optional<String> reduceBy,
                                               Optional<String> expand,
                                               Optional<Boolean> overrideEditableFlag,
                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add worklog

Adds a worklog to an issue.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

This operation can be accessed anonymously.

Permissions required:

• Browse projects and Work on issues project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Parameters:

issueIdOrKey -

The ID or key the issue.

(required)

requestBody - (required)

notifyUsers -

Indicates whether users watching the issue are notified by email.

(optional, default to true)

adjustEstimate -

Defines how to update the issue's time estimate, the options are:

• new Sets the estimate to a specific value, defined in newEstimate.
• leave Leaves the estimate unchanged.
• manual Reduces the estimate by amount specified in reduceBy.
• auto Reduces the estimate by the value of timeSpent in the worklog.

(optional, default to auto)

newEstimate -

The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is new.

(optional)

reduceBy -

The amount to reduce the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m). For example, 2d. Required when adjustEstimate is manual.

(optional)

expand -

Use expand to include additional information about work logs in the response. This parameter accepts multiple values separated by a comma:

• properties Returns worklog properties.

(optional, default to "")

overrideEditableFlag -

Indicates whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Only connect app users with admin scope permission can use this flag.

(optional, default to false)

restRequestEnhancer -

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

Returns:

Single<Worklog>

deleteWorklog

public io.reactivex.Completable deleteWorklog(String issueIdOrKey,
                                              String id,
                                              Optional<Boolean> notifyUsers,
                                              Optional<String> adjustEstimate,
                                              Optional<String> newEstimate,
                                              Optional<String> increaseBy,
                                              Optional<Boolean> overrideEditableFlag,
                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete worklog

Deletes a worklog from an issue.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

This operation can be accessed anonymously.

Permissions required:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.
• Delete all worklogs project permission to delete any worklog or Delete own worklogs to delete 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)

id -

The ID of the worklog.

(required)

notifyUsers -

Indicates whether users watching the issue are notified by email.

(optional, default to true)

adjustEstimate -

Defines how to update the issue's time estimate, the options are:

• new Sets the estimate to a specific value, defined in newEstimate.
• leave Leaves the estimate unchanged.
• manual Increases the estimate by amount specified in increaseBy.
• auto Reduces the estimate by the value of timeSpent in the worklog.

(optional, default to auto)

newEstimate -

The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is new.

(optional)

increaseBy -

The amount to increase the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is manual.

(optional)

overrideEditableFlag -

Indicates whether the work log entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Only connect app users with admin permissions can use this flag.

(optional, default to false)

restRequestEnhancer -

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

Returns:

Completable

getIssueWorklog

public io.reactivex.Single<PageOfWorklogs> getIssueWorklog(String issueIdOrKey,
                                                           Optional<Long> startAt,
                                                           Optional<Integer> maxResults,
                                                           Optional<String> expand,
                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue worklogs

Returns all worklogs for an issue.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

This operation can be accessed anonymously.

Permissions required: Workloads are only returned where the user has:

• Browse projects project permission for the project that the issue is in.
• If issue-level security 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)

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. The maximum is 1048576.

(optional, default to 1048576)

expand -

Use expand to include additional information about worklogs in the response. This parameter accepts multiple values separated by a comma:

• properties Returns worklog properties.

(optional, default to "")

restRequestEnhancer -

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

Returns:

Single<PageOfWorklogs>

getWorklog

public io.reactivex.Single<Worklog> getWorklog(String issueIdOrKey,
                                               String id,
                                               Optional<String> expand,
                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get worklog

Returns a worklog.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

This operation can be accessed anonymously.

Permissions required:

• Browse projects project permission for the project that the issue is in.
• If issue-level security 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)

id -

The ID of the worklog.

(required)

expand -

Use expand to include additional information about work logs in the response. This parameter accepts multiple values separated by a comma:

• properties Returns worklog properties.

(optional, default to "")

restRequestEnhancer -

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

Returns:

Single<Worklog>

updateWorklog

public io.reactivex.Single<Worklog> updateWorklog(String issueIdOrKey,
                                                  String id,
                                                  Worklog requestBody,
                                                  Optional<Boolean> notifyUsers,
                                                  Optional<String> adjustEstimate,
                                                  Optional<String> newEstimate,
                                                  Optional<String> expand,
                                                  Optional<Boolean> overrideEditableFlag,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update worklog

Updates a worklog.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

This operation can be accessed anonymously.

Permissions required:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.
• Edit all worklogs project permission 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 the issue.

(required)

id -

The ID of the worklog.

(required)

requestBody - (required)

notifyUsers -

Indicates whether users watching the issue are notified by email.

(optional, default to true)

adjustEstimate -

Defines how to update the issue's time estimate, the options are:

• new Sets the estimate to a specific value, defined in newEstimate.
• leave Leaves the estimate unchanged.
• auto Updates the estimate by the difference between the original and updated value of timeSpent or timeSpentSeconds.

(optional, default to auto)

newEstimate -

The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is new.

(optional)

expand -

Use expand to include additional information about worklogs in the response. This parameter accepts multiple values separated by a comma:

• properties Returns worklog properties.

(optional, default to "")

overrideEditableFlag -

Indicates whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Only connect app users with admin permissions can use this flag.

(optional, default to false)

restRequestEnhancer -

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

Returns:

Single<Worklog>