REST API: Tree Folders

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 (0 = disabled (default), 1 = enabled)
n	string	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.

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/folders

Responses

status 200 application/json Returned if successful.

Example

[ 
   { 
      "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
   }
]

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

https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/folder?name=My%20Folder&description=This%20is%20my%20folder

Responses

status 200 application/json Returned if successful.

Example

{ 
   "name":"Test",
   "id":76,
   "display_name":"Test",
   "parent":-1,
   "folders":[ 

   ],
   "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.

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

https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/folder/100?name=My%20Folder&description=This%20is%20my%20folder

Responses

status 200 application/json Returned if successful.

Example

{ 
   "name":"Child",
   "id":77,
   "display_name":"Child",
   "parent":76,
   "folders":[ 

   ],
   "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.

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

{ 
   "name":"Updated folder name"
}

Sample Request Path

https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/folder/100

Responses

status 200 text/plain Returned if successful.

Folder rename 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.

Deletes a folder from a given project

Request

PATH PARAMETERS

parameter	type	description

parameter	type	description
prjKey	string	project key
id	string	folder id

Sample Request Path

https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/folder/100

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 a folder to another folder within the given project since 4.2.2

Request

PATH PARAMETERS

parameter	type	description

parameter	type	description
prjKey	string	project key
id	string	folder id of folder to be moved

REQUEST BODY PARAMETERS

Example

{
   "folder":{
      "id":600
   },
   "position":1
}

Sample Request Path

https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/projects/ABCD/folder/100/move/folder

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.

easeRequirements Data Center - Requirements Management for Jira

REST API: Tree Folders

Returns complete tree structure for specified folder (with or without issues)

Returns complete folder structure for given project

Creates a new folder under the root folder of a given project

Creates a new folder under a specified folder of a given project

Renames a specific folder for a given project

Deletes a folder from a given project

Moves a folder to another folder within the given project since 4.2.2

Related content