Export and download XML requirements data (easesolutions/R4J)

[Anton Sixtenson]

Hi!

I am facing two problems I cannot seem to find any answers to.

I am using Jira 9.12.4. (Jira Data Center and Server). I have several different projects, each with different requirement specifications defined using easesolution plugin. In the Jira web GUI I can click a "Export" button for each requirements specification and download a XML file with the data in the description field. However the data from the details field is not included. This is my first problem. 

The second problem is that I would like to automate this process using the API.  So for each directory in a project in the requirements tab, I would like to export and download the data as XML. Is this possible?

Thanks in advance!

[Edmer John Sarmiento]

Hi @Anton Sixtenson

I'm Edmer from EaseSolutions, vendor of R4J/easeRequirements plugin. 

Is the XML export that you use the one directly in Jira Issue View?

The XML export above is a built-in feature of Jira. Unfortunately, I couldn't find a REST API for it. I found this Atlassian Jira Ticket which says this feature wasn't pushed through: https://jira.atlassian.com/browse/JRASERVER-45786. 

In R4J/easeRequirements Tree View, we have an XML Export feature, although we have no REST API for it. 

If the "details" fields you mean missing in the Export are the ones like: Type, Labels, Resolution etc. These fields are included with the Jira XML export and R4J Tree View XML export if you select an Issue. If you select a Folder, the issues under it doesn't include these fields in the XML Export.

Best regards,

Edmer

[Anton Sixtenson]

Thanks for the answer @Edmer John Sarmiento

The reason I would like to do this is because at my workplace we are currently using two different requirement handling tools. We want to get the data from both these tools in a uniform format to be able to link them to actual testcases and their pass/fail history, and then present this data for developers, PO's etc.

Just a wildcard question: Do you have any directions you could point me at regarding automatically getting the data for defined requirements in Jira/R4J? 

As of now the only solution I can see is to crawl the Jira portal using playwright, selenium or similar framework to automatically scrap data from the portal.

EDIT (just to clarify):
If I navigate to a specific requirement:

http://jira.my-company:8080/plugins/servlet/com.easesolutions.jira.plugins.requirements/project?detail=PROJECT_KEY&issueKey=ISSUE_KEY

And then click on the IssueKey value. I Get presented with a page:
http://jira.my-company:8080/browse/ISSUE_KEY

Here I can click "Export" -> XML and I get present with all the data I want in XML format, this page will have the address:
http://jira.my-company:8080/si/jira.issueviews:issue-xml/ISSUE_KEY/ISSUE_KEY.xml

This XML file have all the data I am interested in.

EDIT 2:
I found a hacky way to get the data I want. It seems I can just use the link:

http://jira.my-company:8080/si/jira.issueviews:issue-xml/ISSUE_KEY/ISSUE_KEY.xml

And input any existing value for ISSUE_KEY. So I can then use a curl command like this:
curl -u myuser:mypass \

http://jira.my-company:8080/si/jira.issueviews:issue-xml/ISSUE_KEY/ISSUE_KEY.xml

To get the data. However, some information, like what directory it resides in, etc is missing. It does seem like internally Jira is using an ID rather than the assigned folder name, so I do not know how to solve this.

Thanks in advance, and hope I have presented the issue correctly!

[Edmer John Sarmiento]

Hi @Anton Sixtenson

If you wish to get the Issue Path which is shown in easeRequirements view, you can create a custom field type "R4J Path".

Note: This is just a read-only field and with Jira Export/Import you can't use it to move the requirements in the tree structure. The XML data from this field can be exported within the issue by "Export" -> XML.

Best regards,

Edmer

[Edmer John Sarmiento]

Hi @Anton Sixtenson

You may also use our REST API: REST API 2.0 Reference, to get all the folders and it's data in the tree view.

GET /projects/{projectKey}/folders

Best regards,

Edmer