DATA CENTER AND SERVER | CLOUD
REST API: Tree Folders
Angelica Salazar
Bernhard Doleschel
Returns complete tree structure for specified folder (with or without issues)
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 |
|---|---|---|
folderOnly | string | toggles include issues in folder |
n | string | toggles structure numbering prefix for folder names |
Sample Request Path
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/foldertree/100?folderOnly=0&n=1Responses
status 200 application/json Returned if successful.
Example
{
"name":"Test Project",
"id":1,
"name_display":"Test Project",
"parent":0,
"folders":[
{
"name":"Test",
"id":67,
"name_display":"Test",
"parent":-1,
"folders":[
{
"name":"Second",
"id":68,
"name_display":"Second",
"parent":67,
"folders":[
],
"issues":[
{
"id":127,
"issueId":10155,
"key":"AN-2",
"url":"http://<server-name>/browse/AN-2",
"summary":"Second",
"description":"Second",
"icon_url":"http://<server-name>/images/icons/issuetypes/newfeature.png",
"issueType":"New Feature",
"position":1
},
{
"id":118,
"issueId":10154,
"key":"AN-1",
"url":"http://<server-name>/browse/AN-1",
"summary":"First",
"description":"First issue textasd",
"icon_url":"http://<server-name>/images/icons/issuetypes/newfeature.png",
"issueType":"New Feature",
"position":2
}
],
"position":1
}
],
"issues":[
],
"position":1
},
{
"name":"Root",
"id":75,
"name_display":"Root",
"parent":-1,
"folders":[
],
"issues":[
],
"position":2
},
{
"name":"Test",
"id":70,
"name_display":"Test",
"parent":-1,
"folders":[
],
"issues":[
],
"position":3
}
],
"issues":[
],
"position":1
}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.
Returns complete folder structure for given project
Request
PATH PARAMETERS
parameter | type | description |
|---|
parameter | type | description |
|---|---|---|
prjKey | string | project key |
Sample Request Path
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/foldersResponses
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.
Creates a new folder under 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 |
|---|---|---|
name | string | the name of the folder to be created |
description | string | optional description of the folder to be created |
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.
Creates a new folder under a specified 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 |
|---|---|---|
name | string | the name of the folder to be created |
description | string | optional description of the folder to be created |
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.
Renames a specific folder for a given project
Request
PATH PARAMETERS
parameter | type | description |
|---|
parameter | type | description |
|---|---|---|
prjKey | string | project key |
id | string | folder id |
REQUEST BODY PARAMETERS
Example
Sample Request Path
Responses
status 200 text/plain 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.