Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
hiddentrue
nameScripting

Learn how to script the creation of requirements through the REST API

We are often asked whether it is possible to scrit script the creation of requirements, etc.

Accessing the Jira issue through the REST API

It is possible to access the details of a Jira issue using:

{baseUrl}/rest/api/latest/issue/{issueKey}

For example, assuming the Jira issue is http://jira.local:2990/jira/browse/SCRUM-10, then the REST API is http://jira.local:2990/jira/rest/api/latest/issue/SCRUM-10.

It is also possible to write into the same URL. For example, go to a Jira issue, open the Javascript console and write the following code (after modifying the parameters) and it will set the requirements to FN-01:

...

For example, assuming TEAM as a space key: http http://confluence.local:1990/confluence/rest/reqs/1/requirement2/TEAM

The full REST documentation (URL parameters, etc.) is provided there: https://docs.requirementyogi.com/restapison our developer portal.