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

Has anyone produced and willing to share a working example of the Align API to produce a Feature Lis

With the availability of the JIRA Align REST API, we ar starting to explore how to better integrate the information in to some of our other dashboard experiences and tools.  

It wold be REALLY COOL of someone produced a (free please) confluence macro that used the API and allowed my to plug in a feature list or story list filtered by team or PI or some other.

Any examples or any takers?

Atlassian?  This wold help bring Align on par with JIRA...

2 answers

Do you refer to API v1.0 or API v2?

Like John Pimentel likes this

Great thanks @Daniel_Hursh, now I know which API we are discussing.

I have managed to figure out how the API works, which means I can query and use it as curl instructions and to load data via the API into PowerBI and/or MS Excel via PowerQuery.

However, it was during this discovery and experimentation process that I discovered the following:

  • Swagger documentation for the APIs is not sufficient for the general user to understand and successfully implement API queries,
  • The APIs implement pagination, which significantly increases the API's level of complexity. However, the approach is aligned with how Atlassian implemented the JIRA Software APIs. Unfortunately, the pagination is not documented anywhere on the API site, and I requested via a support call that the pagination implementation approach details are shared in order for us to understand how pagination needs to be handled. At the moment the maximum number of entries that an API request return is 100.

I will let you know as soon as I get answers and detail about on the pagenation implementation I will provide an update.  

@Daniel_Hursh the only answer that I got, is a confirmation that it was indeed implemented but not documented, and that the Swagger documentation doesn't work as Atlassian expected. So I am still struggling to figure out how to retrieve more than a 100 entries of endpoints of work-items via PowerQuery.

0 votes
Tina Behers Community Leader May 15, 2020

@Daniel_Hursh  Glad to see you're exploring the new API!  The Cprime team is looking into a lot of different options for the new API.  Getting information to confluence is lower on our priority list as we hope a Jira Align to Confluence plugin is in the near(er) future.  :)  

If I read your message correctly, you want to have a confluence page that will pull in a filtered (presumably by PI or Train) list of features & stories.  I assume able to be refreshed on-demand when on the confluence page.  Do I have it right? 

I'd like to be able to pick any of the levels when I use the macro (epic, capability, feature) and then include some set of time or team filters - yes.

Idea is to be able to provide some easier access views to the lists of items for those who are not Align savvy, or to show the information through some of the confluence based portals we have in place.

Like # people like this
Tina Behers Community Leader May 20, 2020

Hi Dan! 

good news!  after much experimentation, we have figured out how to do this!   We are working on a prototype.  Would love to review that prototype with you!  If you're game reach out via my cell (same that I've had for years now) and we'll show ya what we've got and see where the holes are :). 

 game?  :) 

Hi @Tina Behers 

Our organisation has the same requirements, therefore, I request to also participate please - we are in the process of developing or integrating with a PI planning application for teams - that will make remote/distributed planning during PI planning events easier and more usable. you can reach me at this email: 
Thank you!

Has this effort made any gains since May?  I am very interested in pulling feature data into confluence from Jira Align, but nervous that the docs will not get me there.  Any advice and/or guidance would of course be appreciated.

Nothing has come my way yet.
Some other people in our organisation also tried to access it. Still, the API tokens only seem to return results if the user has the system role of Super Admin, All other API tokens return "access denied" error messages. 

In essence, the API is still unusable by 99% of the user community in our organisation. 

Suggest an answer

Log in or Sign up to answer
Community showcase
Published in Jira Align

Helpful hints if you're rolling Align out to your entire enterprise

(Or, What to expect when you’re expanding.) Once you've completed your Jumpstart, or your initial assessment of Jira Align, you'll start to think about how you can roll it out to the rest of your e...

1,618 views 6 33
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