JQL Query System vs Rest API

Question

So I am an old school on-prem DB user of Jira. A lot of my knowledge base is from 2011. I am in a new business, and I have been cramming tons of new knowledge about Jira Software, and all of the other systems.

While adjusting to the newer systems, I am having a bit of a struggle. We don't have an enterprise license, so from my understanding I have no way to use JQL outside of the advanced issue search. I want to actually query for data within systems. I have no real expertise in Rest API, so I am trying to learn. But I'm finding it a bit confusing.

Do I have any realistic options of being able to query data outside of the advanced issue search? Can I perform the same types of data lookups with the Rest API? Do you have any recommendations on where to start in a ELI5 on Rest API commands, and even staging how to run the commands?

This would help greatly as I build more automations for my business' projects. Thanks for any information provided!

Andrew O_Rourke · Answer

Alright, so I think I am making some progress. We currently use Postman in our app stack. So I am trying to understand how to set up my variables. I downloaded the Postman collection provided by Jira.

I think I am struggling with finding the right documentation to make sure I am setting it up correctly.

Collections = Storage of my commands

Environments = The specific system that I am making the calls to

So if my thought are correct, I would create an Environment for Jira. Then use the predefined (or custom) calls from the collections to that environment.

I see that technically I can set up the authorization within the "Jira Cloud platform REST API" collection that is provided. But I think I'm misunderstanding if I should use variables, or a different auth type.

Does what I am explaining make sense? I don't fully know where to go from here. I can provide photos if needed.

Pablo V. · Answer

Hi @Andrew O_Rourke

You can certainly use a Jira Cloud REST API endpoint when looking for issues using JQL. Please refer to the /rest/api/2/search specific-endpoint documentation at https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-search/#api-rest-api-2-search-get

The syntax will vary depending on what scripting/programming language/tool you're using to execute the API call/request.

A hypothetic example using CURL is shown below (token modified for security purposes):

curl -X GET -u test@servicerocket.com:ATATT3xFfGF05qT2WVXAcEXSz5_7aUka6aCKVIcAr05U72l27GyS--B-1RdX1lkNOSQLbwfeTfsy8O5pcq4tTTLLXrphwT3dNJSxdRjXUZmEHPDlb0VUnB2kx01sSr_Ysancrh_5c3HB9vyYUTDOKQKqJh9WpeRKUhsKxalainvp1EwiT9Wenn0=...blah https://pablo.atlassian.net/rest/api/2/search?jql=project%20%3D%20YOUR_PROJECT

I hope this helps you!

- Pablo