Does JIRA-API-Model support following object constellation (Dashboard -> Gadget -> Filter -> Query)?

I want to get all gadgets in a particular dashboard and the filter in all gadgets and the query in the filter.

Does JIRA-API-Model support that way of accessing a query like shown below?

Dashboard -> Gadget -> Filter -> Query

Via PortletConfigurationManager I've already tried to get from my dashboard to its gadgets and from the gadgets to their filter.

But the only method when I get a particular PortletConfiguration is getGadgetUri() to get somehow to a gadget. It always leads me like the method's name already says to


From this point I don't know how to go on in order to get to that filter that is saved in the gadget.

1 answer

1 accepted

Ok, finally I found a solution how to resolve that Problem.

With the PortletPageService you can get the PortletConfigurations. Every PortletConfiguration in the PortletConfiguerartions allocates a Map with UserPrefs. And profoundly hidden in this Map, you can find the filterId as a String. With SearchRequestService you are able to find a filter by id.

Unfortunatley, there were no further detailed infos on the JIRA API when it comes to the getUserPrefs()-Method

Here is the method how you get all Queries from a Dashboard:

public List<Query> getAllQueriesFromDashboard(PortalPage dashboard)
      PortalPageService pps = ComponentAccessor.getComponent(PortalPageService.class);
      SearchRequestService srs = ComponentAccessor.getComponent(SearchRequestService.class);
      Set<String> filterIds = new HashSet<String>();
      List<Query> queries = new ArrayList<Query>();
      // get dashboard by id
      List<List<PortletConfiguration>> portletConfigurations = pps.getPortletConfigurations(getJiraServiceContext(), dashboard.getId());        
      //get all gadgets
      for(int i = 0; i<portletConfigurations.size(); i++)
         List<PortletConfiguration> lpc = portletConfigurations.get(i);
         for(int j = 0; j<lpc.size(); j++)
            PortletConfiguration pc = lpc.get(j);
            Map<String, String> userPrefs = pc.getUserPrefs();

            for(Entry<String, String> x : userPrefs.entrySet())
                  filterIds.add(x.getValue().replace("filter-", ""));     
      // get all filters by Id --> get all Queries
      Iterator<String> it = filterIds.iterator();
         Long id = Long.parseLong(;
         SearchRequest sr = srs.getFilter(getJiraServiceContext(), id);
         Query q = sr.getQuery();
      return queries;

Suggest an answer

Log in or Join to answer
Community showcase
Sarah Schuster
Posted Jan 29, 2018 in Jira

What are common themes you've seen across successful & failed Jira Software implementations?

Hey everyone! My name is Sarah Schuster, and I'm a Customer Success Manager in Atlassian specializing in Jira Software Cloud. Over the next few weeks I will be posting discussion topics (8 total) to ...

3,293 views 14 20
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot