DATA CENTER AND SERVER | CLOUD
REST API: Tree Issues
Bernhard Doleschel
Angelica Salazar
Adds an existing issue to the root folder of a given project
Request
PATH PARAMETERS
parameter | type | description |
|---|
parameter | type | description |
|---|---|---|
prjKey | string | project key |
QUERY PARAMETERS
parameter | type | description |
|---|
parameter | type | description |
|---|---|---|
issuekey | string | the key of the issue to be associated |
Sample Request Path
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/rootissue?issuekey=ABCD-100Responses
status 200 application/json Returned if successful.
Example
{
"id":136,
"issueId":0,
"key":"",
"url":"",
"summary":"",
"description":"",
"issueType":"",
"position":0,
"childReqs":{
"childReq":[
]
}
}status 400 Returned if there is an error while processing request.
status 401 Returned if user is not logged in.
status 403 Returned if the license is invalid or has expired or incompatible JIRA version.
Removes an issue from the root folder of a given project
Note that the issue will only be removed from the tree and not deleted from Jira.
Request
PATH PARAMETERS
parameter | type | description |
|---|
parameter | type | description |
|---|---|---|
prjKey | string | project key |
QUERY PARAMETERS
parameter | type | description |
|---|
parameter | type | description |
|---|---|---|
issuekey | string | the key of the issue to be deleted |
Sample Request Path
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/rootissue?issuekey=ABCD-100Responses
status 200 Returned if successful.
status 400 Returned if there is an error while processing request.
status 401 Returned if user is not logged in.
status 403 Returned if the license is invalid or has expired or incompatible JIRA version.
Adds an existing issue to a specified tree folder of a given project
Request
PATH PARAMETERS
parameter | type | description |
|---|
parameter | type | description |
|---|---|---|
prjKey | string | project key |
id | string | folder id |
QUERY PARAMETERS
parameter | type | description |
|---|
parameter | type | description |
|---|---|---|
issuekey | string | the key of the issue to be associated |
Sample Request Path
Responses
status 200 application/json Returned if successful.
Example
status 400 Returned if there is an error while processing request.
status 401 Returned if user is not logged in.
status 403 Returned if the license is invalid or has expired or incompatible JIRA version.
Removes an issue from a specified tree folder of a given project
Note that the issue will only be removed from the tree and not deleted from Jira.
Request
PATH PARAMETERS
parameter | type | description |
|---|
parameter | type | description |
|---|---|---|
prjKey | string | project key |
id | string | folder id |
QUERY PARAMETERS
parameter | type | description |
|---|
parameter | type | description |
|---|---|---|
issuekey | string | the key of the issue to be deleted |
Sample Request Path
Responses
status 200 Returned if successful.
status 400 Returned if there is an error while processing request.
status 401 Returned if user is not logged in.
status 403 Returned if the license is invalid or has expired or incompatible JIRA version.
Moves an existing issue association to a new folder
Request
PATH PARAMETERS
parameter | type | description |
|---|
parameter | type | description |
|---|---|---|
prjKey | string | project key |
QUERY PARAMETERS
parameter | type | description |
|---|
parameter | type | description |
|---|---|---|
from | string | the ID of the source folder |
to | string | the ID of the destination folder |
issuekey | string | the key of the issue whose association should be moved |
pos | string | position of the issue in the destination folder since 4.2.1 |
Sample Request Path
Responses
status 200 Returned if successful.
status 400 Returned if there is an error while processing request.
status 401 Returned if user is not logged in.
status 403 Returned if the license is invalid or has expired or incompatible JIRA version.