I don't understand the deprecation of Rest endpoints

[Darryl Rosin]

Hello.

First, I am not a web guy, I build reports and I only became an admin of our Jira Cloud a couple of weeks ago so I didn't know this change was coming until this afternoon. I don;t know anything about forge, curl, node.js, java, python or Php so the examples are not helpful.

I'm using web.contents() in Power Query to get Jira data into our reporting system  using Web.contents like this: Web.Contents(URL&"/rest/api/2/search?filter=-4")

When I read the documentation at The Jira Cloud platform REST API

it seems to tell me that "https://your-domain.atlassian.net/rest/api/3/search" is being removed and I should start using 'https://your-domain.atlassian.net/rest/api/3/search/jql?jql=blahblah'

Do I just have to replace the reference to the filter in the URL with the JQL that defines the filter in order to use the new endpoint?

How do I know if I am using the old endpoint or the new endpoint?

Thank-you!

d

[Evgenii]

Hi, @Darryl Rosin

Welcome to Atlassian Community!

Deprecation is a normal process; methods are continuously optimized to improve stability, speed, and functionality.

In your case, you don't need to make major changes.
You just need to update the query.

Change this:
Web.contents like this: Web.Contents(URL&"/rest/api/2/search?filter=123456")

To this:
Web.contents like this: Web.Contents(URL&"/rest/api/3/search/jql?jql=filter%20%3D%20123456")

%20%3D%20 in query - it's " = ", encoded to HTML.

Important notice: Jira does not resolve built-in filters like -1, -2, -3, etc. in the API query.
Therefore, it's better to create a custom filter with the same criteria, share it with everyone, and use its ID in the query, as shown in the example above.

[Darryl Rosin]

Thank-you and sorry for my delayed reply. I am grateful that you are taking the time to help me out!

I'd like to follow up with one problem. The new endpoint appears to only return issue IDs but the old one gave me all the issue data. That is, when I look in a browser

/rest/api/3/search?filter=14401 returns a list of records gives me id, key, and all the other fields (parent id, parent key, project, summary, description, labels, assignee, creator, custom fields etc etc) as records nested within 'fields'

but

/rest/api/3/search/jql?jql=filter%20%3D%2014401 only gives me the issue id. How do I get the rest of the issue data?

Thnaks!

[Darryl Rosin]

(I have a sinking feeling you're going to tell me I need to write my own functions that get the issue ids by page, combine the ids into a comma delimited string for each page, then loop through the list of strings, calling /rest/api/3/issue/bulkfetch on each item... :(  )

[Benjamin]

HI @Darryl Rosin ,

Welcome! The old endpoint is quite different. The sql is written in the payload when writing a Curl. Instead, the new one simpler where you just put the JQL right into the URL as shown. 

Basically, if you follow this example URL, you are already using the new endpoint.

'https://your-domain.atlassian.net/rest/api/3/search/jql?jql=blahblah'


Just replace with your cloud URL and what JQL string you want to use as your search filter. 

-Ben

[Darryl Rosin]

Thank-you Ben. I have replied more substantively to Evgenii above, but I would appreciate your resonse, if you have one. :)

d