Jira REST API for Beginners

Sharing buttons:

hello everyone in this video let us talk

about JIRA REST API in case you are

interested in doing some kind of

integration with the JIRA maybe you have

some other tools in your organization

maybe you want to push or maybe pull

some data out of JIRA or maybe you for

some reason want to pull data out of

JIRA and do some reporting maybe in your

own tool so the good news is that you

can definitely do it by using a JIRA

REST API so whether you're using JIRA 7

of you or if you are using JIRA core

version this REST API will be there for

you of course the API is a bit different

on cloud if you compare it with server

but let us say if you are on server you

can do a quick Google search just type

on Google JIRA REST API and you will

reach this page so on this particular

page you have various definitions of

what all you can do with the vajira so

in this particular JIRA REST API so in

this particular video I want to give you

a very quick introduction of JIRA REST

API and for showing how you can use the

JIRA REST API you can of course do it

using any programming language but if

you want to do something very quickly if

you if you want to test this API you can

also do it using your browser or you can

use curl for example if you are using

Linux or Mac so for this example I will

be using one plug-in one extension on

Chrome called rest let client rest API

test testing so this is one extension

that I have installed on my browser and

there are different plugins extensions

available for Chrome and Firefox so you

can use any West client and using

browser is quite convenient because you

can do lot of things very easily so for

this particular example let us do very

simple thing

try to understand if we can pull

something out of zero so for doing this

I will be showing you how we can pull

the issue from JIRA in JIRA we have

different issues and for each in every

issue you have of course this unique key

data is really important and based on

the on the key we can we can basically

pull the information all of JIRA and we

can take a look at how it will look like

when you use the REST API so for doing

this we first need to understand how to

use the REST API and if you open this

particular page called JIRA server

platform REST API reference and by the

we are talking about JIRA eight point

two point zero so this particular page

is applicable for this version of JIRA

so this is something that you should be

aware of so let us say if you want to do

something with issue so if you and by

the raw this particular page you have

some examples you can now read them but

let us quickly try to do something with

the issue using our get so if you're

working with the API if you have of

course different ways for putting the

information which is usually which is

usually using gate you can also update

something you can also do something with

JIRA or let us say if you want to create

an issue so we have different references

with different examples for creating

issue and also for getting the issue so

if you click on get issue you can read

this example and you also have different

things that you can also do with of

course your issue so the good thing that

the good thing is tight on this

particular page you have the URIs and

these URLs will help you in using the

right method or right definition for

example if you want to get the shoe

details so you can go to your browser

and right now I'm looking at this rest

line so all you need to do use your JIRA

URL and

then use this this this pot called rest

/ api / 2 & 4 and after that you of

course have the actual resource that you

want to use and this is of course based

on the page where you can find

everything that you can potentially do

potentially do with the dearest api so

for searching the details of a

particular issue you can use this path

and let us say if you want to pull the

information of one issue called

x-ray - 17 so if I open this issue in my

JIRA of course it is a subtask but let

us start to see if we can search it

using REST API so of course you need to

also add some authentication details

here so on this particular extension you

can define your username and password

and you can then start using it straight

away so right now the method is get so

that is really important and if you

click on the send button you will get

this response straight away within your

browser so you can see here that on the

right hand side we have this body and

you can now see here that we have the

issue ID which is basically for the

parent because it is a subtask

so you know that this is definitely a

child or it is a subtasks you can take a

look at all the custom fields if there

are any for this particular issue you

can take a look at all the details that

can be fetched from this REST API so

this is really great because using this

this API you can fetch the details of an

issue this is something that you can use

for maybe sending this information to a

different tool maybe you want to also

create this issue maybe in a different

instance of JIRA or maybe in a different

tool altogether so this can be done

programmatically so let us take a look

at one more example and this example is

really useful because you may want to

search for issues based on letters

the jql so there is a separate the URL

is there a separate resource called

rest / API slash - which is I believe

the a perversion and followed by search

so let us do this and I'll replace my

existing URL with this new one and for

this particular for this particular

method you need to basically provide

your jaql so whatever jaql that you will

provide as a parameter or for this

resource you will be able to such those

issues that will be returned by that

particular is equal so let us try

something very simple let us say we have

project is equal to x-ray

so idly this should return all the

issues from this particular project

called x-ray which is my key of course

so let us see if it works or not

so it is still taking some time and now

you can see here that we have 283 issues

that are returned and by the way but

this particular JSON file that you can

see right here on this particular page

it will only display a maximum of 50 but

this can be changed you can of course

take a look at the the definition to get

more details about how to play with the

with the rest api so important thing to

know here it is that if you expand this

you will get the individual issues so

you have of course so the first issue

which is x-ray 17 then next to a 16 and

so on and we can do we can quickly

verify this if I go back to my issue

navigator let me do a fresh search and

type in project is equal to X ray and

this will let us see how many how many

issues are returned so it is now

returning 17 issues so I think I did

something wrong here okay so I think I

did something wrong with the with the

parameters of the parameter should start

with jaql

equal to project equal to X ray which is

mine of course actual jaql so now it's a

start we are returning 17 issues and you

can of course verify that we indeed have

17 issues so let's do something a bit

more lengthy so if you type in here jaql

is equal to X ray and I just want to

search my open issues may be or may be I

think all of the issues are open I'll

probably use a different project here so

project is equal to maybe Android

development project and I may want to

search only open issues so let us do

this and let us see how many issues are

there in the jaql so we have two issues

only so this is all right so let us

quickly copy the whole jaql and paste it

after the jaql part and if i press the

send button we do have two results so

this is really important this is really

useful because using this search method

you can retrieve the issues based on

jaql and these two are just two simple

examples and the whole idea here in this

video is to demonstrate how you can also

get started with the rest api the first

step is of course to understand what all

you can do with the with the JIRA REST

API and then of course use your client

it could be your browser extension it

could be your console use curl or maybe

use any client that you might be

familiar with and when you know those

methods and you know what you can do

potentially with those definitions of

REST API you can then start working with

your coding you can probably write a

code to do more wonderful things and

with the help of REST API you have

endless possibilities when it comes to

integrations because when it comes to

integrations so you can definitely push

and also pulled out our model zero and

this is all I wanted to show in this

video thank you very much