Rally Software

Expand all | Collapse all

Inquiry on API for Epics

Jump to Best Answer
  • 1.  Inquiry on API for Epics

    Posted 05-25-2018 03:16 PM

    Can someone explain to me the basic difference between the data in the EPIC API and the Portfolio Item API when looking at an EPIC.  Why is the data different for the same exact fields?  Thank you!



  • 2.  Re: Inquiry on API for Epics

     
    Posted 05-25-2018 10:24 PM

    Hi Rebecca, I am very familiar with Rally's APIs but don't know what you mean by the "EPIC API". Do you have an example URL for a call you're making against that API? Is it part of WSAPI, or something different?



  • 3.  Re: Inquiry on API for Epics

    Posted 05-29-2018 11:32 AM

    From my developer:

    The original issue that prompted the question looks like it has resolved itself.  Trying to figure out how and why….but would still like a double check on our understanding.  First some context:

    Perhaps we’re not using the right terms (please coach us) ---  when we say EPIC API --- we’re referring to the endpoint below:

     https://rally1.rallydev.com/slm/webservice/v2.0/portfolioitem/epic?workspace=https://rally1.rallydev.com/slm/webservice/v2.0/workspace/***********&query=&fetch=true&start=1&pagesize=1

    When we say PortfolioItem API – we’re referring to the endpoint below:

    https://rally1.rallydev.com/slm/webservice/v2.0/portfolioitem?workspace=https://rally1.rallydev.com/slm/webservice/v2.0/workspace/***********&query=&fetch=true&start=1&pagesize=1

     Our process involves loading the data from these 2 endpoints into 2 tables in our database.  The available columns for each table were determined by having Visual Studio interpret and create the various classes in the underlying JSON data at each endpoint.   We use those classes in a script task in SSIS to extract the data and route to appropriate columns for each table.

    What prompted the question, was that we were getting different values for percent done by story count and percent done by plan estimate for a given Epic’s formatted ID when querying the table with data from the EPIC endpoint and comparing that data to the table with PortfolioItem endpoint data.

     

    Our assumption was that this data should be the same – and it looks like it is now for us.  The discrepancy was most likely self-inflicted.  

     

    So, with that context – we wanted to check our understanding of the functional relationship between Epic and Portfolio Item endpoints.  (This would also apply to Features and MBIs since each of those also have their own endpoints and are included in the PortfolioItem endpoint’s data.)



  • 4.  Re: Inquiry on API for Epics
    Best Answer

     
    Posted 05-30-2018 02:27 PM

    Thanks for the detail Rebecca! Per the name 'Epic API', each customer can customize their names for Portfolio Items, so they may not have an API about Epics. I would generally refer to these as the portfolioitem endpoints of WSAPI.

     

    As for those two endpoints, they should return the same data. The two types are to help you focus on specific Portfolio Item Types.

     

    If you have other questions or would like more detail, please let me know. You can also ask more on our Stack Overflow group - Newest 'rally' Questions - Stack Overflow