Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


GETcom.easesolutions.jira.plugins.requirements/1.0/issue/req-path/jql

Get all requirement paths for all issues returned by a specific JQL query.

(warning) Known issue: Does not work for JQL using path delimiters.
Fixed in com.easesolutions.jira.plugins.requirements/1.0/issue/req-path

POSTcom.easesolutions.jira.plugins.requirements/1.0/issue/req-path
Status
title4.2.0
 Get all requirement paths for all issues returned by a specific JQL query.

...

Panel
titleColor#FFFFFF
titleBGColor#6c809a
titlecom.easesolutions.jira.plugins.requirements/1.0/issue/req-path/jql

Get all requirement paths for all issues returned by the given JQL query.

Info

Since an issue can be part of multiple project trees there may exist more than one requirement path for an issue.
This function lists all requirements paths for an issue for all project trees that contain this issue.
The set of issues to return the requirement paths for is determined by the given JQL query.


Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
GET

/rest/com.easesolutions.jira.plugins.requirements/1.0/issue/req-path/jql



PARAMETERS
parametertypedescription
jql*stringthe JQL statement



RESPONSES

Status
colourGreen
titleSTATUS 200
- Returned if a requirements path for an issue is found

Code Block
languagejava
titleExample Response
[
	{ 
		issueKey: "TEST-1",
		paths: [
			{
				projectKey: "TEST"
				path: "/MyPath/Test"
			},
			{
				projectKey: "PROD"
				path: "/TestFolder"
			}
		]
	},
	{
		issueKey: "TEST-2",
		paths: []
	},
	{
		issueKey: "TEST-3",
		paths: [
			{
				projectKey: "TEST"
				path: "/TestFolder"
			}
		]
	}
]

Status
colourRed
titleSTATUS 400
- Returned if the JQL is invalid

Status
colourRed
titleSTATUS 401
- Returned if invalid user credentials, or the user has no permission

Status
colourRed
titleSTATUS 403
- Returned if the license is invalid or has expired, or incompatible JIRA version



Anchor
getreqpath2getreqpath
2

Panel
titleColor#FFFFFF
titleBGColor#6c809a
titlecom.easesolutions.jira.plugins.requirements/1.0/issue/req-path

Get all requirement paths for all issues returned by the given JQL query. (info) Supports JQL with path delimiters

Info

Since an issue can be part of multiple project trees there may exist more than one requirement path for an issue.
This function lists all requirements paths for an issue for all project trees that contain this issue.
The set of issues to return the requirement paths for is determined by the given JQL query.


Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/issue/req-path



PARAMETERS
parametertypedescription
jql*stringthe JQL statement



RESPONSES

Status
colourGreen
titleSTATUS 200
- Returned if a requirements path for an issue is found

Code Block
languagejava
titleExample Response
[
	{ 
		issueKey: "TEST-1",
		paths: [
			{
				projectKey: "TEST"
				path: "/MyPath/Test"
			},
			{
				projectKey: "PROD"
				path: "/TestFolder"
			}
		]
	},
	{
		issueKey: "TEST-2",
		paths: []
	},
	{
		issueKey: "TEST-3",
		paths: [
			{
				projectKey: "TEST"
				path: "/TestFolder"
			}
		]
	}
]

Status
colourRed
titleSTATUS 400
- Returned if the JQL is invalid

Status
colourRed
titleSTATUS 401
- Returned if invalid user credentials, or the user has no permission

Status
colourRed
titleSTATUS 403
- Returned if the license is invalid or has expired, or incompatible JIRA version


...