Support

Expand all | Collapse all

Traceability - Links to Items - API-ID vs. Project-ID

Jump to Best Answer
  • 1.  Traceability - Links to Items - API-ID vs. Project-ID

    Posted 02-13-2018 04:48
    Hello there,

    Sometimes we need to trace our Requirements to the Program Code of our Product. Here we are using Doxygen to create some Report about the Code. Now we want to get a Link of our Items in Jama - to achiev the best possible traceability.
    How many/Which possibilities there are to get these Links? We know the easy way: click on => Actions => Email Link after that include this link.

    But Doxygen allows us to create some HTML-Link with a prefix.
    Example: Standard- Link: "https://serverxyz.net/perspective.req?projectId=01&docId=" while writing the documentation we can add this Standard-Link into the documentation and add the Prefix like the API-ID: 99999
    so we create a Hyperlink with these reference: "https://serverxyz.net/perspective.req?projectId=01&docId=99999"

    But we dont want to use our API-ID to "connect" doxygen to our requirements. We would like to use our Jama Project-ID's because these are splitted and named about the Topics that is coded.

    Is there any way to connect Jama-Items from other sources with the Project-ID. Or is it possible to use some API to map the Project-ID back to the API-ID ?

    Thanks!!


    ------------------------------
    D
    ------------------------------


  • 2.  RE: Traceability - Links to Items - API-ID vs. Project-ID
    Best Answer

    Posted 02-13-2018 15:07

    Hey D!

    There isn't a way to force the URL to display the Unique ID rather than the API ID, for the API ID is the only immutable ID that Jama items carry (Unique IDs can be changed when you alter a set key, for instance, and Global IDs depend on an item's sync status, if any). You could use /abstractitems to get items with a specific documentKey, e.g.

    response = requests.get('http://localhost:8080/contour/rest/latest/abstractitems?documentKey=AGILE_-STY-4', auth=('sample', 'password'))


    (In this case, sample and password are the user and the URL is a placeholder for a local instance). However, I don't know how that would help you achieve your end goal, but it's really the only bit of information I can offer. We unfortunately don't have resources for using Jama with many development tools, only Subversion. Hopefully someone subscribing to this section has overcome the same issue and can comment.



    ------------------------------
    Kristina King
    Jama Software
    ------------------------------



  • 3.  RE: Traceability - Links to Items - API-ID vs. Project-ID

    Posted 02-14-2018 04:39
    At first thanks a lot Kristina,

    if i have understood correctly - we need the REST API

    Next Step: Get REST API from our internal Admin

    Thanks!!

    ------------------------------
    D
    ------------------------------