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

Class AuditRecordsApi

java.lang.Object

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

public class AuditRecordsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<AuditRecords>	getAuditRecords(Optional<Integer> offset, Optional<Integer> limit, Optional<String> filter, Optional<OffsetDateTime> from, Optional<OffsetDateTime> to, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get audit records Returns a list of audit records.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditRecordsApi

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

Method Detail

getAuditRecords

public io.reactivex.Single<AuditRecords> getAuditRecords(Optional<Integer> offset,
                                                         Optional<Integer> limit,
                                                         Optional<String> filter,
                                                         Optional<OffsetDateTime> from,
                                                         Optional<OffsetDateTime> to,
                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get audit records Returns a list of audit records. The list can be filtered to include items: * containing a string in at least one field. For example, providing *up* will return all audit records where one or more fields contains words such as *update*. * created on or after a date and time. * created or or before a date and time. * created during a time period. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

offset - The number of records to skip before returning the first result. (optional, default to 0)

limit - The maximum number of results to return. (optional, default to 1000)

filter - The query string. (optional)

from - The date and time on or after which returned audit records must have been created. If `to` is provided `from` must be before `to` or no audit records are returned. (optional)

to - The date and time on or before which returned audit results must have been created. If `from` is provided `to` must be after `from` or no audit records are returned. (optional)

restRequestEnhancer -

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

Returns:

Single<AuditRecords>