Uploaded image for project: 'Advanced Roadmaps'
  1. Advanced Roadmaps
  2. JPOSERVER-438

Implement a REST API for JIRA Portfolio

This issue belongs to an archived project. You can view it, but you can't modify it. Learn more

    • JIRA feedback is collected from a number of different sources and is evaluated when planning the product roadmap. If you would like to know more about how JIRA Product Management uses customer input during the planning process, please see our post on Atlassian Answers.

      NOTE: This suggestion is for JIRA Portfolio Server. Using JIRA Portfolio Cloud? See the corresponding suggestion.

      Given Portfolio's proposal of being a project management tool for just about everything on a company and its features that allow for Project Managers to better plan resources, it would be nice to have a REST API (similar to what JIRA already has for its Core features) to integrate it with an external application, such as a Paycheck System or an HR Management Tool.

            [JPOSERVER-438] Implement a REST API for JIRA Portfolio

            Hi all,

            With the release of Portfolio for Jira API, we would like to start capturing your requests for future improvements and functionalities.

            Please leave comments on what you want us to build and why it is important for you in this ticket: https://jira.atlassian.com/browse/JPOSERVER-2322

            Thanks you!

            The Portfolio for Jira team

            Roi Fine (Inactive) added a comment - Hi all, With the release of Portfolio for Jira API, we would like to start capturing your requests for future improvements and functionalities. Please leave comments on what you want us to build and why it is important for you in this ticket: https://jira.atlassian.com/browse/JPOSERVER-2322 Thanks you! The Portfolio for Jira team

            Got it, thank you!

            Any plans for the Cloud REST API?

            Dmitry Astapkovich _Colined_ added a comment - Got it, thank you! Any plans for the Cloud REST API?

            Thomas added a comment -

            Thomas added a comment - Hi dmitry.astapkovich , I would suggest looking at the 2.13 release notes page here: https://confluence.atlassian.com/display/JIRAPortfolio/Portfolio+for+Jira+2.13+release+notes

            The is resolved, but I can't find any updates for the API in the docs. Could you please provide us with the updated links?

            Dmitry Astapkovich _Colined_ added a comment - The is resolved, but I can't find any updates for the API in the docs. Could you please provide us with the updated links?

            The suspense is killing us 

            Shawn Danisa added a comment - The suspense is killing us 

            michal.gawlik,

            I can't disclose dates for future versions and I'd keep this conversation thread API focused  But I'll just say that Portfolio 3.0 status = In progress AND it's going to be awesome!

            Roi Fine (Inactive) added a comment - michal.gawlik , I can't disclose dates for future versions and I'd keep this conversation thread API focused  But I'll just say that Portfolio 3.0 status = In progress AND it's going to be awesome!

            Sounds like Portfolio 3.0  Do you have any scheduled date to release... or I am asking for too much?

            Michal Gawlik added a comment - Sounds like Portfolio 3.0  Do you have any scheduled date to release... or I am asking for too much?

            Roi Fine (Inactive) added a comment - - edited

            Hi guys,

            The next API update, available very soon, will include the ability to get Portfolio's hierarchy configuration. Along with a JAVA API, in addition to the REST one. 

            Cheers, 

            Roi Fine (Inactive) added a comment - - edited Hi guys, The next API update, available very soon, will include the ability to get Portfolio's hierarchy configuration. Along with a JAVA API, in addition to the REST one.  Cheers, 

            +1 for the Hierarchy. Not only the Configuration though, but API to get the complete tree for any issue. Current "Parent link scheme" is not enough.

            Dmitry Astapkovich _Colined_ added a comment - +1 for the Hierarchy. Not only the Configuration though, but API to get the complete tree for any issue. Current "Parent link scheme" is not enough.

            Hi,

            Is there a plan to create API endpoint to get Portfolio Hierarchy Configuration?

            Regards,
            Janis Baiza
            eazyBI

            Jānis Baiža (eazyBI) added a comment - Hi, Is there a plan to create API endpoint to get Portfolio Hierarchy Configuration? Regards, Janis Baiza eazyBI

            Hi all, 

            A few weeks passed since we released our beta for Portfolio API. For any of you who already tried it and want to share feedback, we would appreciate your help by filling the following form: https://goo.gl/forms/w7ewy7CQg0AhRuxH3

            Thanks,

            The Portfolio for Jira team

            Roi Fine (Inactive) added a comment - Hi all,  A few weeks passed since we released our beta for Portfolio API. For any of you who already tried it and want to share feedback, we would appreciate your help by filling the following form: https://goo.gl/forms/w7ewy7CQg0AhRuxH3 Thanks, The Portfolio for Jira team

            Roi Fine (Inactive) added a comment - - edited

            Hi all,

            We apologies for the confusion.

            To get started you will need all URL paths to start with /jira/rest/teams-api/1.0

            In example the skill count URL is: /jira/rest/teams-api/1.0/skill/count

            We updated the intro in the docs as well - https://docs.atlassian.com/portfolio-for-jira-server/REST/2.12.0/

            Thanks,

            The Portfolio for Jira team

             

            Roi Fine (Inactive) added a comment - - edited Hi all, We apologies for the confusion. To get started you will need all URL paths to start with /jira/rest/teams-api/1.0 In example the skill count URL is: /jira/rest/teams-api/1.0/ skill/count We updated the intro in the docs as well -  https://docs.atlassian.com/portfolio-for-jira-server/REST/2.12.0/ Thanks, The Portfolio for Jira team  

            What's the URI to access the API? Your documentation doesn't specify how I actually access the API just what calls I can make.

            Radford Software added a comment - What's the URI to access the API? Your documentation doesn't specify how I actually access the API just what calls I can make.

            Roi Fine (Inactive) added a comment - - edited

            Hi all,

            We now have public REST APIs in beta phase for Portfolio for Jira. The API is for team management only, main functionalities are:

            • Setting availability & absences of team members 
            • Listing the teams and members defined in Portfolio plans including skills

            This is our first iteration — we will add more capabilities in the future.

            As the API is still in beta phase, do share your feedback and thoughts here.

            See our REST API docs to know more.

            Thanks,

            The Portfolio for Jira team

            Roi Fine (Inactive) added a comment - - edited Hi all, We now have public REST APIs in beta phase for Portfolio for Jira. The API is for team management only, main functionalities are: Setting availability & absences of team members  Listing the teams and members defined in Portfolio plans including skills This is our first iteration — we will add more capabilities in the future. As the API is still in beta phase, do share your feedback and thoughts here. See our  REST API docs  to know more. Thanks, The Portfolio for Jira team

            As teams are migrating projects from Rally and into JIRA, we have automated the process to build out the new projects based on the SAFe model.   However, we have to manually configured the parent relationships within Portfolio.   Even smaller teams with only a few dozen issues are running into major delays as they configure the links.   Attempting to update the two custom fields via API fails due to the fact that either they can't be mapped to the screen or the field is locked.   Until there is an available API for Jira Portfolio, is there a potential workaround for updating the custom fields?

            David Oyler added a comment - As teams are migrating projects from Rally and into JIRA, we have automated the process to build out the new projects based on the SAFe model.   However, we have to manually configured the parent relationships within Portfolio.   Even smaller teams with only a few dozen issues are running into major delays as they configure the links.   Attempting to update the two custom fields via API fails due to the fact that either they can't be mapped to the screen or the field is locked.   Until there is an available API for Jira Portfolio, is there a potential workaround for updating the custom fields?

            DavidN added a comment -

            Really appreciate your comment @Matthew, we don't have Structure in our installation but we do have Adaptivist Script Runner. That gives us IssueFunction - PortfolioParentsOf() and PortfolioChildrenOf() which does what the new child function does in v2.10 (can't wait until we get approval to get that installed!). Not sure how to access that through Groovy script. Anyway, given child issues are listed in parent issue and Script Runner is able to do this. We are hoping there is an API or programmatic way to do this now. 

            Thank you again.

            DavidN added a comment - Really appreciate your comment @Matthew, we don't have Structure in our installation but we do have Adaptivist Script Runner. That gives us IssueFunction - PortfolioParentsOf() and PortfolioChildrenOf() which does what the new child function does in v2.10 (can't wait until we get approval to get that installed!). Not sure how to access that through Groovy script. Anyway, given child issues are listed in parent issue and Script Runner is able to do this. We are hoping there is an API or programmatic way to do this now.  Thank you again.

            One thing we did is use ALMWorks Structure to expose and traverse the Portfolio Heirachy thru the Structure Rest API. it will let you get the whole Portfolio tree and know what the parent/child relationships are. You may find that to be a good workaround until the official API arrives. That said with 2.10's new JQL features for getting all issues in a portfolio and the children of things you may also be able to do similar without Structure albeit likely with a little more work to reconstruct the tree...

             

            Matthew Thompson added a comment - One thing we did is use ALMWorks Structure to expose and traverse the Portfolio Heirachy thru the Structure Rest API. it will let you get the whole Portfolio tree and know what the parent/child relationships are. You may find that to be a good workaround until the official API arrives. That said with 2.10's new JQL features for getting all issues in a portfolio and the children of things you may also be able to do similar without Structure albeit likely with a little more work to reconstruct the tree...  

            DavidN added a comment -

            Any ETA when this will be available? We are looking at implementing some business rules to do with hierarchy / Parent Link and unable to do so. Appreciate any help you can provide. Thanks. 

            DavidN added a comment - Any ETA when this will be available? We are looking at implementing some business rules to do with hierarchy / Parent Link and unable to do so. Appreciate any help you can provide. Thanks. 

            Great to see that the ticket is "in progress" now. I am product manager of Backbone Issue Sync for Jira and we'd really like to integrate with Jira Portfolio - therefore an API would be awesome where you could get and set the issue-related fields of Jira Portfolio.

            Matthias Gaiser [K15t] added a comment - Great to see that the ticket is "in progress" now. I am product manager of Backbone Issue Sync for Jira and we'd really like to integrate with Jira Portfolio - therefore an API would be awesome where you could get and set the issue-related fields of Jira Portfolio.

            DavidN added a comment -

            We echo what others have said here. Any update on this? We are increasingly reliant on portfolio plugin but the inability to report on portfolio fields is creating significant amount of angst amongst users. Appreciate if you could look at this with some urgency.

            Currently, some are exporting all data and rebuilding semantics outside. This is very painful even when it works. As many have mentioned, Team doesn't show team name but ID anyway. Portfolio plan export also shows items in order as listed in the plan making it hard to consume if one were to see or traverse hierarchy. After all, this is what portfolio is all about - to plan, track and manage hierarchy of objects. 

            Thanks!

            DavidN added a comment - We echo what others have said here. Any update on this? We are increasingly reliant on portfolio plugin but the inability to report on portfolio fields is creating significant amount of angst amongst users. Appreciate if you could look at this with some urgency. Currently, some are exporting all data and rebuilding semantics outside. This is very painful even when it works. As many have mentioned, Team doesn't show team name but ID anyway. Portfolio plan export also shows items in order as listed in the plan making it hard to consume if one were to see or traverse hierarchy. After all, this is what portfolio is all about - to plan, track and manage hierarchy of objects.  Thanks!

            Being able to interact with the Team custom field would be awesome! Also goes for Java API so that I can work with it using e.g. Scriptrunner.

            Kristofer Hansson Aspman [Riada] added a comment - Being able to interact with the Team custom field would be awesome! Also goes for Java API so that I can work with it using e.g. Scriptrunner.

            I would like to echo essentially all that has been requested above.

            Top of our list would be the ability to read all date fields, eg as a function of plan/scenario, individual item etc.

            We also need to be able to remotely force plan/scenario re-calculation.

            But ultimately we would be looking for the ability, via the REST API, to access all data fields and perform all current actions that are currently performed via the Portfolio UI.

            Lastly, does provision of a REST API exist on the current Portfolio road-map, and if it does, could you give some indication of when it might be available?

            Thanks!

             

            Ian Kitching added a comment - I would like to echo essentially all that has been requested above. Top of our list would be the ability to read all date fields, eg as a function of plan/scenario, individual item etc. We also need to be able to remotely force plan/scenario re-calculation. But ultimately we would be looking for the ability, via the REST API, to access all data fields and perform all current actions that are currently performed via the Portfolio UI. Lastly, does provision of a REST API exist on the current Portfolio road-map, and if it does, could you give some indication of when it might be available? Thanks!  

            Hi Roi,

            I'd like to chime-in on the need for creating/updating Teams via the API. This function is key from an enterprise server standpoint.

            Heather Rimmey added a comment - Hi Roi, I'd like to chime-in on the need for creating/updating Teams via the API. This function is key from an enterprise server standpoint.

            Thanks for your reply guys, we will keep you updated on this ticket.

            Cheers,

            The Portfolio for Jira team

            Roi Fine (Inactive) added a comment - Thanks for your reply guys, we will keep you updated on this ticket. Cheers, The Portfolio for Jira team

            I Roi,

            Things we do today: We use Structure and it's API to get the Portfolio tree. it'd be nice if Portfolio API supported that directly.

            We'd like to do is be able to set Portfolio computed date values back into JIRA and set input values into Portfolio. Right now we use some mix of the API and parsing reports to do that. This could be by API or some kind of "Publish Dates" feature whereby we then pick them up thru the issue REST API.

            We'd like to be able to get at computed resource assignments at team and individual level, and team member info.

            We'd like to be able to have teams self maintain membership of LDAP groups or similar. But failing that with an API to manipulate teams we could do that.

             

            Matthew Thompson added a comment - I Roi, Things we do today: We use Structure and it's API to get the Portfolio tree. it'd be nice if Portfolio API supported that directly. We'd like to do is be able to set Portfolio computed date values back into JIRA and set input values into Portfolio. Right now we use some mix of the API and parsing reports to do that. This could be by API or some kind of "Publish Dates" feature whereby we then pick them up thru the issue REST API. We'd like to be able to get at computed resource assignments at team and individual level, and team member info. We'd like to be able to have teams self maintain membership of LDAP groups or similar. But failing that with an API to manipulate teams we could do that.  

            Hi Roi!

            We have a cloud instance. We hope that the implementation will be for both onpremise and cloud versions.

             

            After that, the first need is a full read API of any of custom objects/fields is needed. Teams&membership, cross-project releases, themes, multiple-assignments, resource capability and availabity, stages and skills. All dates.

            A full query capability could be excellent to access the portfolio tree, filter by any portfolio field, etc.

            Kind regards,

            Alexis

            Alexis Torchinsky added a comment - Hi Roi! We have a cloud instance. We hope that the implementation will be for both onpremise and cloud versions.   After that, the first need is a full read API of any of custom objects/fields is needed. Teams&membership, cross-project releases, themes, multiple-assignments, resource capability and availabity, stages and skills. All dates. A full query capability could be excellent to access the portfolio tree, filter by any portfolio field, etc. Kind regards, Alexis

            Eric Kish added a comment -

            Manage vacations via API

            Read Individual Utilization to save it in a data warehouse for further analytics

             

            Eric Kish added a comment - Manage vacations via API Read Individual Utilization to save it in a data warehouse for further analytics  

            Hi Roi,

            I really want to access team information. In our own add-on, WorklogPRO, we have introduce our own team feature for just timesheet reporting. This is not good for users, they may have to re-create teams for different add-ons. If you can centralise team information, other add-ons may check whether Portfolio add-on exist and if it exist they may use team already defined in Portfolio.

            Regards,

            Deniz Oğuz - The Starware added a comment - - edited Hi Roi, I really want to access team information. In our own add-on,  WorklogPRO , we have introduce our own team feature for just timesheet reporting. This is not good for users, they may have to re-create teams for different add-ons. If you can centralise team information, other add-ons may check whether Portfolio add-on exist and if it exist they may use team already defined in Portfolio. Regards,

            Hi all,

            We are looking into adding a public API for Portfolio for Jira. We would love to hear from you about the "must have" capabilities you are looking for. 

            Please tell us in a comment what are you looking to achieve with our API.

            Cheers,

            The Portfolio for JIRA team

            Roi Fine (Inactive) added a comment - Hi all, We are looking into adding a public API for Portfolio for Jira. We would love to hear from you about the "must have" capabilities you are looking for.  Please tell us in a comment what are you looking to achieve with our API. Cheers, The Portfolio for JIRA team

            Hi Guys,

            Integration roadmap of different products are hinged on the availability of a supported API for Portfolio. 

            Even if you can give a tentative timeline idea like, it will be available anywhere between 6 months - 1 year, then it will help.

            Thanks!

            Vishal Mudgal added a comment - Hi Guys, Integration roadmap of different products are hinged on the availability of a supported API for Portfolio.  Even if you can give a tentative timeline idea like, it will be available anywhere between 6 months - 1 year, then it will help. Thanks!

            April added a comment -

            Maybe you could just humor us with a non-committal reply? We really, really need this functionality, so any hint of interest on your part would be very reassuring.

            April added a comment - Maybe you could just humor us with a non-committal reply? We really, really need this functionality, so any hint of interest on your part would be very reassuring.

            Any update, Atlassian?

            This is impacting both customers and vendors - we want to be able to print child issues on cards from the "Agile Cards" plugin (which is a feature they need an API to implement), and we also need to convert normal JIRA links into "Parent Links" due to the way you've implemented this field.

            Maree Milne added a comment - Any update, Atlassian? This is impacting both customers and vendors - we want to be able to print child issues on cards from the "Agile Cards" plugin (which is a feature they need an API to implement), and we also need to convert normal JIRA links into "Parent Links" due to the way you've implemented this field.

            Hi,

            APIs for JIRA Portfolio (server) would be absolutely a major value for all our customization needs

            Yogesh Joshi added a comment - Hi, APIs for JIRA Portfolio (server) would be absolutely a major value for all our customization needs

            Matthew, I need it as vendor =) And Structure is not available in the Cloud 

            Дмитрий Астапкович added a comment - Matthew, I need it as vendor =) And Structure is not available in the Cloud 

            Dmitry a kinda roundabout way of doing this is to use the Structure plugin to define a Portfolio based tree then use Structure's APIs to get the Portfolio tree. 

            Matthew Thompson added a comment - Dmitry a kinda roundabout way of doing this is to use the Structure plugin to define a Portfolio based tree then use Structure's APIs to get the Portfolio tree. 

            Please provide at least API to get issues structure for external reports. 

            Dmitry Astapkovich _Colined_ added a comment - Please provide at least API to get issues structure for external reports. 

            We need an official, supported API to interact with JIRA Portfolio(Cloud instance).

            Alexis Torchinsky added a comment - We need an official, supported API to interact with JIRA Portfolio(Cloud instance).

            +1. Not really sure why initiatives would get their own linking plumbing at all, but if you're going to do that at least provide some kind of documentation letting us use and report on it.

            Haddon Fisher added a comment - +1. Not really sure why initiatives would get their own linking plumbing at all, but if you're going to do that at least provide some kind of documentation letting us use and report on it.

            As the multi project release and team availability obviously has an impact on other systems, it would be nice to have both the possibility to read and modify that data over REST endpoints.

            Deleted Account (Inactive) added a comment - As the multi project release and team availability obviously has an impact on other systems, it would be nice to have both the possibility to read and modify that data over REST endpoints.

            Hani Juha added a comment -

            managing team availability in JIRA through an API is becoming critical to us. individual availability is tracked through gcal or through wiki calendars.  I then have to input the same data into portfolio.  Not optimal. 

            Hani Juha added a comment - managing team availability in JIRA through an API is becoming critical to us. individual availability is tracked through gcal or through wiki calendars.  I then have to input the same data into portfolio.  Not optimal. 

            Marcus added a comment -

            We do definitely also need some REST API features for JIRA Portfolio. Hope this requirement will be prioritized up.

            Marcus added a comment - We do definitely also need some REST API features for JIRA Portfolio. Hope this requirement will be prioritized up.

            April added a comment -

            We also need it to develop on top, as the provided reporting is not quite what we are looking for.

            April added a comment - We also need it to develop on top, as the provided reporting is not quite what we are looking for.

            Christian Di Fiore added a comment - - edited

            I need it to develop on top and customized processes we implemented in my company.

            Any progress on this topic would be appreciated.

            Christian Di Fiore added a comment - - edited I need it to develop on top and customized processes we implemented in my company. Any progress on this topic would be appreciated.

            I agree with Tom, it's very disappointing, no news and as per the Atlassian New Feature policy, you don't publish roadmap.

            It would be fine to have at least an idea of when we could expect something, because we don't really know where this product is going  

            Fabien Tillay added a comment - I agree with Tom, it's very disappointing, no news and as per the Atlassian New Feature policy, you don't publish roadmap. It would be fine to have at least an idea of when we could expect something, because we don't really know where this product is going  

            What the latest status about the Portfolio API ? as an official customer we received a while ago a documentation about a BETA version of a Portfolio 2.0 API but no news since then

            Thanks in advance for your information

            Fabien Tillay added a comment - What the latest status about the Portfolio API ? as an official customer we received a while ago a documentation about a BETA version of a Portfolio 2.0 API but no news since then Thanks in advance for your information

            Very disappointing the lack of response from Atlassian on requests for API support in Portfolio. JPO-438 opened in Jul 2015 and no response...

            Tom McCarthy added a comment - Very disappointing the lack of response from Atlassian on requests for API support in Portfolio. JPO-438 opened in Jul 2015 and no response...

            A simple compromise would be to create a portfolio type category that tracks nested issues. E.g. I create a custom issue type and can select "Portfolio" vs. "Standard" and when I do that it tracks its nested children, e.g. it could track multiple epics, etc.

            If you do that, you can actually use the existing API to at least get at the actual issues and their parent/child relations, which would be simple and allow a lot of options.

            Either that or just modify the portfolio commit functionality to add direct child issues to the custom "standard" issue type. This latter option might make more sense. Less modification.

            Currently, no issues are shown for custom hierarchy issue types.

            Mark Foster added a comment - A simple compromise would be to create a portfolio type category that tracks nested issues. E.g. I create a custom issue type and can select "Portfolio" vs. "Standard" and when I do that it tracks its nested children, e.g. it could track multiple epics, etc. If you do that, you can actually use the existing API to at least get at the actual issues and their parent/child relations, which would be simple and allow a lot of options. Either that or just modify the portfolio commit functionality to add direct child issues to the custom "standard" issue type. This latter option might make more sense. Less modification. Currently, no issues are shown for custom hierarchy issue types.

            Access to the initiatives and their rank, names, descriptions, etc.

            Mark Foster added a comment - Access to the initiatives and their rank, names, descriptions, etc.

            mmathes added a comment -

            ... for example to set the availability of team members from the central hr application.

            mmathes added a comment - ... for example to set the availability of team members from the central hr application.

              tbarthelemy Thomas
              raiderrobert Robert Roskam
              Archiver:
              atibrewal@atlassian.com Aakrity Tibrewal

                Created:
                Updated:
                Resolved:
                Archived: