DATA CENTER AND SERVER | CLOUD
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 23 Current »
Request
PATH PARAMETERS
parameter
type
description
prjKey
string
project key
id
folder id
QUERY PARAMETERS
folderOnly
toggles include issues in folder (0 = disabled (default), 1 = enabled)
n
toggles structure numbering prefix for folder names (0 = disabled (default), 1 = enabled)
Sample Request Path
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/foldertree/100?folderOnly=0&n=1
Responses
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.
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/folders
[ { "folders":[ { "folders":[ ], "name":"Folder 1.1", "id":10 }, { "folders":[ ], "name":"Folder 1.2", "id":11 } ], "name":"Folder 1", "id":5 }, { "folders":[ ], "name":"Folder 2", "id":6 }, { "folders":[ { "folders":[ ], "name":"Folder 3.1", "id":8 }, { "folders":[ ], "name":"Folder 3.2", "id":9 } ], "name":"Folder 3", "id":7 } ]
name
the name of the folder to be created
optional description of the folder to be created
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/folder?name=My%20Folder&description=This%20is%20my%20folder
{ "name":"Test", "id":76, "display_name":"Test", "parent":-1, "folders":[ ], "issues":[ ], "position":1 }" "
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/folder/100?name=My%20Folder&description=This%20is%20my%20folder
{ "name":"Child", "id":77, "display_name":"Child", "parent":76, "folders":[ ], "issues":[ ], "position":1 }" "
REQUEST BODY PARAMETERS
{ "name":"Updated folder name" }
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/folder/100
STATUS 200 text/plain Returned if successful.
Folder rename successful.
STATUS 200 Returned if successful.
folder id of folder to be moved
{ "folder":{ "id":600 }, "position":1 }
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/projects/ABCD/folder/100/move/folder