com.atlassian.jira.rest.v2.admin.auditing

Class AuditingResource

java.lang.Object

com.atlassian.jira.rest.v2.admin.auditing.AuditingResource

public class AuditingResource
extends Object

Resource representing the auditing records

Since:

6.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	JIRA_REST_PLUGIN_KEY

Constructor Summary

Constructors

Constructor and Description
AuditingResource(I18nHelper i18nHelper, AuditingService auditingService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addRecord(AuditRecordBean bean, javax.servlet.http.HttpServletRequest request) Store a record in Audit Log
javax.ws.rs.core.Response	getRecords(Integer offset, Integer limit, String filter, org.joda.time.DateTime from, org.joda.time.DateTime to, String projectIds, String userIds) Returns auditing records filtered using provided parameters

Methods inherited from class java.lang.Object

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

Field Detail

JIRA_REST_PLUGIN_KEY

public static final String JIRA_REST_PLUGIN_KEY

See Also:

Constant Field Values

Constructor Detail

AuditingResource

public AuditingResource(I18nHelper i18nHelper,
                        AuditingService auditingService)

Method Detail

getRecords

public javax.ws.rs.core.Response getRecords(Integer offset,
                                            Integer limit,
                                            String filter,
                                            org.joda.time.DateTime from,
                                            org.joda.time.DateTime to,
                                            String projectIds,
                                            String userIds)

Returns auditing records filtered using provided parameters

Parameters:

offset - - the number of record from which search starts

limit - - maximum number of returned results (if is limit is <= 0 or > 1000, it will be set do default value: 1000)

filter - - text query; each record that will be returned must contain the provided text in one of its fields

from - - timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty only records that where created in the same moment or after the 'from' timestamp will be provided in response

to - - timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty only records that where created in the same moment or earlier than the 'to' timestamp will be provided in response

projectIds - - list of project ids to look for

userIds - - list of user ids to look for

Returns:

auditing records with all associated objects

Since:

6.3

addRecord

public javax.ws.rs.core.Response addRecord(AuditRecordBean bean,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request)

Store a record in Audit Log

Since:

6.3