Versions Compared

Key

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

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

Expand
titleGET com.easesolutions.jira.plugins.requirements/1.0/tree/{prjKey}/foldertree/{id}

Request

PATH PARAMETERS

parameter

type

description

prjKey

string

project key

id

string

folder id

QUERY PARAMETERS

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

Code Block
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/foldertree/100?folderOnly=0&n=1

Responses

Status
colourGreen
titlestatus 200
application/json Returned if successful.

Example

Code Block
languagejson
{ 
   "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
colourRed
titlestatus 400
Returned if there is an error while processing request.

Status
colourRed
titlestatus 401
Returned if user is not logged in.

Status
colourRed
titlestatus 403
Returned if the license is invalid or has expired or incompatible JIRA version.

...

Expand
titleGET com.easesolutions.jira.plugins.requirements/1.0/tree/{prjKey}/folders

Request

PATH PARAMETERS

parameter

type

description

prjKey

string

project key

Sample Request Path

Code Block
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/folders

Responses

Status
colourGreen
titlestatus 200
application/json Returned if successful.

Example

Code Block
[ 
   { 
      "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
colourRed
titlestatus 400
Returned if there is an error while processing request.

Status
colourRed
titlestatus 401
Returned if user is not logged in.

Status
colourRed
titlestatus 403
Returned if the license is invalid or has expired or incompatible JIRA version.

...

Expand
titlePOST com.easesolutions.jira.plugins.requirements/1.0/tree/{prjKey}/folder

Request

PATH PARAMETERS

parameter

type

description

prjKey

string

project key

QUERY PARAMETERS

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

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

Responses

Status
colourGreen
titlestatus 200
application/json Returned if successful.

Example

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

   ],
   "issues":[ 

   ],
   "position":1
}" "

Status
colourRed
titlestatus 400
Returned if there is an error while processing request.

Status
colourRed
titlestatus 401
Returned if user is not logged in.

Status
colourRed
titlestatus 403
Returned if the license is invalid or has expired or incompatible JIRA version.

...

Expand
titlePOST com.easesolutions.jira.plugins.requirements/1.0/tree/{prjKey}/folder/{id}

Request

PATH PARAMETERS

parameter

type

description

prjKey

string

project key

id

string

folder id

QUERY PARAMETERS

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

Code Block
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
colourGreen
titlestatus 200
application/json Returned if successful.

Example

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

   ],
   "issues":[ 

   ],
   "position":1
}" "

Status
colourRed
titlestatus 400
Returned if there is an error while processing request.

Status
colourRed
titlestatus 401
Returned if user is not logged in.

Status
colourRed
titlestatus 403
Returned if the license is invalid or has expired or incompatible JIRA version.

...

Expand
titlePUT com.easesolutions.jira.plugins.requirements/1.0/tree/{prjKey}/folder/{id}

Request

PATH PARAMETERS

parameter

type

description

prjKey

string

project key

id

string

folder id

REQUEST BODY PARAMETERS

Example

Code Block
{ 
   "name":"Updated folder name"
}

Sample Request Path

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

Responses

Status
colourGreen
titlestatus 200
text/plain Returned if successful.

Code Block
Folder rename successful.

Status
colourRed
titlestatus 400
Returned if there is an error while processing request.

Status
colourRed
titlestatus 401
Returned if user is not logged in.

Status
colourRed
titlestatus 403
Returned if the license is invalid or has expired or incompatible JIRA version.

...

Expand
titleDELETE com.easesolutions.jira.plugins.requirements/1.0/tree/{prjKey}/folder/{id}

Request

PATH PARAMETERS

parameter

type

description

prjKey

string

project key

id

string

folder id

Sample Request Path

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

Responses

Status
colourGreen
titlestatus 200
Returned if successful.

Status
colourRed
titlestatus 400
Returned if there is an error while processing request.

Status
colourRed
titlestatus 401
Returned if user is not logged in.

Status
colourRed
titlestatus 403
Returned if the license is invalid or has expired or incompatible JIRA version.

Moves a folder to another folder within the given project
Status
colourBlue
titlesince 4.2.2

Expand
titlePUT com.easesolutions.jira.plugins.requirements/1.0/tree/projects/{prjKey}/folder/{id}/move/folder

Request

PATH PARAMETERS

parameter

type

description

prjKey

string

project key

id

string

folder id of folder to be moved

REQUEST BODY PARAMETERS

Example

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

Sample Request Path

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

Responses

Status
colourGreen
titlestatus 200
Returned if successful.

Status
colourRed
titlestatus 400
Returned if there is an error while processing request.

Status
colourRed
titlestatus 401
Returned if user is not logged in.

Status
colourRed
titlestatus 403
Returned if the license is invalid or has expired or incompatible JIRA version.

...