Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,299,759
Community Members
 
Community Events
165
Community Groups

rest jira api

I have windows 10 and want to know how to get to the Rest API jira console step by step, unfortunately I do not have such knowledge and the instruction in jira is unfriendly to the user. can someone help?

1 answer

0 votes

Hello @Arkadiusz Olszewski ,

Thanks for reaching out and welcome to the community. 

When it comes to pulling data or designing integrations from the API the documentation goes deep fast as there is a lot of nuance in the outcomes which can be quite a barrier to entry but is also vital to successfully navigating the capabilities. There are also variations between product sets like the core Jira platform vs the Jira Software vs Jira Service management in how the data is to be returned, and the best starting point would be the base Atlassian cloud developer documentation 

Unfortunately, there is no easy entry point or single solution step by step process to get things started, as API calls are a complex topic and have a ton of different tools and approaches to interface with them, other than diving into the documentation to start to understand the capabilities and then work towards a goal for the design of the integration you are trying to build out after choosing and learning the tool to make the call.

However, the most basic call you can do to the API is directly in the browser using the desired endpoint as your URL, as browsers will translate the data supplied at an API endpoint url as raw text.

For example, if you run the following in the Browser to see data on a speciffic issue:

https://your-domain.atlassian.net/rest/api/3/issue/{issueIdOrKey}

This would be the equivalent of running the following GET call in a curl from the command line:

curl --request GET \
--url 'https://your-domain.atlassian.net/rest/api/3/issue/{issueIdOrKey}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'

Looking at the pain point you mentioned of how to get to the basis of the console to access the API, there are two main approaches, the first is direct console/terminal access using a command like CURL, which is a linux/unix based command that will be represented quite frequently in the documentation, and on Windows 10 or newer, Curl comes with an operating system (Check out this site giving some more details on curl in windows) noting other than curl there are also formattings like Forge, Node.js, Java, Python, PHPOR that are detailed in the Atlassian API documentation for each endpoint. Alternatively you would want to look at a Windows alternative to curl, Or a third-party tool like PostMan which is an API integration that will launch the curl commands input as a form-based operation vs direct command-line interaction.

Again any of these options will require prerequisite knowledge of the tool you choose to get going with or research on how to use that tool but I hope this information gets you on the right track of where to start looking to get into the API.

Regards,
Earl

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
PREMIUM
TAGS
Community showcase
Published in Jira Service Management

Coming Soon: Insight Changing to Assets

The 2020 acquisition of Mindville added powerful asset and configuration management capabilities to Jira Service Management in the form of Insight. Following the completion of that integration, custo...

440 views 3 13
Read article

Community Events

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

Find an event

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

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you