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

Class WorklogApi

java.lang.Object

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

public class WorklogApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<ChangedWorklogs>	getIdsOfWorklogsDeletedSince(Optional<Long> since, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get IDs of deleted worklogs Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.
io.reactivex.Single<ChangedWorklogs>	getIdsOfWorklogsModifiedSince(Optional<Long> since, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get IDs of updated worklogs Returns a list of IDs and update timestamps for worklogs updated after a date and time.
io.reactivex.Single<List<Worklog>>	getWorklogsForIds(WorklogIdsRequestBean worklogIdsRequestBean, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get worklogs Returns worklog details for a list of worklog IDs.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorklogApi

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

Method Detail

getIdsOfWorklogsDeletedSince

public io.reactivex.Single<ChangedWorklogs> getIdsOfWorklogsDeletedSince(Optional<Long> since,
                                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get IDs of deleted worklogs

Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.

This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs.

This resource does not return worklogs deleted during the minute preceding the request.

Permissions required: Permission to access Jira.

Parameters:

since -

The date and time, in UNIX timestamp format, after which deleted worklogs are returned.

(optional, default to 0l)

restRequestEnhancer -

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

Returns:

Single<ChangedWorklogs>

getIdsOfWorklogsModifiedSince

public io.reactivex.Single<ChangedWorklogs> getIdsOfWorklogsModifiedSince(Optional<Long> since,
                                                                          Optional<String> expand,
                                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get IDs of updated worklogs

Returns a list of IDs and update timestamps for worklogs updated after a date and time.

This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs.

This resource does not return worklogs updated during the minute preceding the request.

Permissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true:

• the worklog is set as Viewable by All Users.
• the user is a member of a project role or group with permission to view the worklog.

Parameters:

since -

The date and time, in UNIX timestamp format, after which updated worklogs are returned.

(optional, default to 0l)

expand -

Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog.

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

getWorklogsForIds

public io.reactivex.Single<List<Worklog>> getWorklogsForIds(WorklogIdsRequestBean worklogIdsRequestBean,
                                                            Optional<String> expand,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get worklogs

Returns worklog details for a list of worklog IDs.

The returned list of worklogs is limited to 1000 items.

Permissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true:

• the worklog is set as Viewable by All Users.
• the user is a member of a project role or group with permission to view the worklog.

Parameters:

worklogIdsRequestBean -

A JSON object containing a list of worklog IDs.

(required)

expand -

Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog.

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