JIRA REST API - how do I get results from a filter?

suhaim abdussamad January 26, 2014

Hi

A GET on rest/api/2/search?jql=filter=123 gets me some info but not the actual results. How do I go about getting the actual results?

4 answers

1 accepted

7 votes
Answer accepted
Timothy
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
January 26, 2014

Your usage of the REST endpoint is wrong. If you have a filter ID, you use this REST endpoint:

https://docs.atlassian.com/jira/REST/latest/#d2e308

This gives you:

 "searchUrl": "http://www.example.com/jira/rest/api/2/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty", 
which you use again get the issues.
suhaim abdussamad January 27, 2014

Thank you that works!

Weston McNamee March 6, 2015

I think what was being asked here, was how would someone execute a filter so that they don't need to manage the query manually. I too would like to know this.

vlada April 21, 2016

yes and Timothy answer provides solution, read it again ...

Claire September 7, 2016

Could you go into a little more detail on this- how can you use the searchUrl from one rest endpoint, to set up another request? Are these all going in the args section of the template function? 

I posted a similar follow up question here: https://answers.atlassian.com/questions/41462677

Mark Cahill September 19, 2016

To clarify the solution above, you are using the filter GET API in order to fetch the definition of the filter as a search url (with embedded JQL), then using that url to fetch the actual filter results from the search API. So your choice is to either embed a filter id in your code, or a JQL statement. If the former, you can at least manage the JQL query within JIRA's interface, and have your code fetch the latest definition of that filter before querying the search API for results.

Like Elizandro G. Roos likes this
2 votes
Stefan Schorn July 25, 2018

It is quite easy, you first have to request the filter: https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-filter-id-get

In the JSON answer the search url is build accordingly in the property "searchUrl".

1 vote
Cma March 23, 2018

My question:

I am new to JIRA api. Could some one help me with this. I have url : /rest/api/2/search?jql=project%3DIR&fields=id,summary,status,customfield_10112,priority,customfield_10115&filter=summary%20%3D%20XXX%20AND%20status%20%3D%20YYY&startAt=0&maxResults=3000

Here I am trying to display fields: id,summary,status,customfield_10112,priority,customfield_10115.

I am trying to filter tickets on the basis of: filter=priority%20%3D%20XXX%20AND%20status%20%3D%20YYY.

XXX and YYY are the custom field which I will replace on the basis of dropdown selected. 

like

XXX="High or Low..."

YYY="In Progress or Open...."

With this I am not getting filter tickets. I am getting all tickets. Can someone help me with this please.

0 votes
Accounting Go2Group January 26, 2014

Your usage of the REST endpoint is wrong. If you have a filter ID, you use this REST endpoint:

https://docs.atlassian.com/jira/REST/latest/#d2e308

This gives you:

 "searchUrl": "http://www.example.com/jira/rest/api/2/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty", 
which you use again get the issues.

Suggest an answer

Log in or Sign up to answer