Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

How do I include an EpicID or EpicName in my Jira API field list

I am making a call for a list of issues in a particular sprint and I would like to include the epic name or id. I have included an example below:

var m_BaseUrl = "https://mysite.atlassian.net/rest/api/latest/search?jql=sprint=588&fields=key,summary";

What fields do I use to get the epic? I have tried epic, and searching for a customField but I am at a loss.

Can someone point me in the right direction before I just iterate through the sprint list and look up the epic?

 

Thanks

 

Peter

1 answer

1 accepted

0 votes
Answer accepted

I found the custom field for my instance after searching the community a little harder. Thanks

Hello @Peter Cleveland , is it possible you could provide a link detailing how you were able to retrieve the epic ID? Thank you!

I don't have a link and it has been a while. But at the high level I learned that when you create your first epic in jira, the system automatically grabs a custom field to story the epic story number in any one issuetype.  So i used the api to grab all of the json data for a couple of stories that had epics and searched the data to find the customfield that held the epics for my instance of JIRA. In my case it was customfield_10009.

I hope that helps you to get it configured.  Example api call....

 

https://yoursitename.atlassian.net/rest/api/latest/search?jql=sprint=" + args[2] + "&fields=key,summary,customfield_10005,customfield_10009&maxResults=150

 

Peter

Is there any way to get an Epic Description, I am able to fetch Epic ID from custom field but not finding it's description any idea from where and how to get it?

best way is to pull fields first before sending your payload, as the project type varies, the property name also varies

 

please use below url for finding required field details

https://community.atlassian.com/t5/Jira-Software-questions/How-do-determine-the-custom-field-number-for-epic-name/qaq-p/1003546

Suggest an answer

Log in or Sign up to answer
TAGS

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