Unable to find or resolve `PageRequest` in Jira Data Center Audit API (9.12.15)

Jira Development Jira Server
,
1

Hi everyone,

I’m currently trying to write a ScriptRunner script in Groovy to access audit logs in Jira Data Center (version 9.12.15). According to the Atlassian Audit API documentation, I should use the AuditSearchService with AuditQuery and PageRequest.

However, I’m completely stuck because the PageRequest class simply cannot be resolved. I’ve tried importing it from multiple suggested packages like:

import com.atlassian.audit.api.pagination.PageRequest
import com.atlassian.audit.api.pagination.PageRequests

or even directly from:

import com.atlassian.audit.api.PageRequest

But none of these imports resolve correctly, and my IDE as well as the ScriptRunner script editor continue to indicate that PageRequest is missing.

Here’s an example of my intended code:

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.audit.api.AuditSearchService
import com.atlassian.audit.api.AuditQuery
import com.atlassian.audit.api.pagination.PageRequests

AuditSearchService auditSearchService = ComponentAccessor.getOSGiComponentInstanceOfType(AuditSearchService)
AuditQuery auditQuery = AuditQuery.builder().searchText("User deactivated").build()

// This line won't compile because PageRequests/PageRequest cannot be found
PageRequest pageRequest = PageRequests.limit(100)

// Intended usage:
def results = auditSearchService.findBy(auditQuery, pageRequest)

Am I missing something crucial here? Are these classes deprecated, moved, or differently implemented in Jira Data Center 9.12.15? I’m quite frustrated because I followed the documentation closely, and yet nothing seems to match my installation.

Any help or clarification would be greatly appreciated!

Thanks!

2

Hi Michel,

Checkout https://developer.atlassian.com/server/framework/atlassian-sdk/audit/

Based on that documentation I updated your script implementation as follows:

import com.atlassian.audit.api.AuditEntityCursor
import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.audit.api.AuditSearchService
import com.atlassian.audit.api.AuditQuery
import com.atlassian.audit.api.util.pagination.PageRequest

AuditSearchService auditSearchService = ComponentAccessor.getOSGiComponentInstanceOfType(AuditSearchService)
AuditQuery auditQuery = AuditQuery.builder().searchText("User deactivated").build()

// from https://developer.atlassian.com/server/framework/atlassian-sdk/audit/
final PageRequest<AuditEntityCursor> pageRequest = new PageRequest.Builder<AuditEntityCursor>()
                .offset(0)
                .limit(100)
                .build();

// Intended usage:
def results = auditSearchService.findBy(auditQuery, pageRequest)

image
image972×609 25.4 KB

Regards,
Christian

1 Like
3

Thanks for your help Christian!
That worked for me !

Kind regards,
Michel

1 Like