REST API: Plan Tree

Owned by Support Advocate (ease solutions)
Last updated: Dec 16, 2016
3 min read
GETcom.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/plan/prjkeyGet the plan tree for a test plan.
POSTcom.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/prjKey/folder/idCreate a folder under a specific parent folder of a plan tree.
DELETEcom.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/prjKey/folder/idDelete a folder from a plan tree.
POSTcom.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/prjKey/folderissue/id

Add an issue to a plan tree folder.

DELETEcom.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/prjKey/folderissue/idRemove an issue from a plan tree folder.
POSTcom.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/prjKey/plan/folderCreate a folder under the root folder of a plan tree.
POSTcom.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/prjKey/plan/moveissueMove an issue from one plan tree folder to another.
DELETEcom.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/prjKey/plan/rootissueRemove an issue from the root folder of a plan tree.



GET /com.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/{plan}/{prjkey}
Example Response 
{
  	"id": 123,
  	"folders": [
    	{
      	"name": "Example Folder",
      	"id": 124,
     	"name_display": ".1 Example Folder",
      	"parent": 123,
      	"folders": [],
      	"issues": [],
      	"position": 1
    	}
  	],
  	"issues": [
    	{
      	"id": 567,
      	"issueId": 12301,
      	"key": "PRJ-1",
      	"url": "http://host:port/jira/browse/PRJ-1",
      	"summary": "Example issue",
      	"icon_url": "http://host:port/jira/images/icons/issuetypes/newfeature.png",
      	"issueType": "New Feature",
      	"position": 1,
      	"teststeps": [
        	{
          	"name": "Teststep 1",
          	"description": "Example teststep",
          	"expectedResult": ""
        	}
      	]
    	}
  	]
}


Get the plan tree for a test plan.


PARAMETERS

prjkey*

plan*

n

details

The project key.

The id of a testplan.

Set 1 to enable auto numbering for tree folders.

Set 1 to include teststeps in the result.

POST /com.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/{prjKey}/folder/{id}
Example Response 
{
  	"name": "exampleSubFolder",
  	"id": 124,
  	"parent": 123,
  	"folders": [],
  	"issues": [],
  	"position": 0
}


Create a folder under a specific parent folder of a plan tree.


PARAMETERS

prjKey*

id*

name*

description

The project key.

The id of the parent folder.

A name for the folder.

A description for the folder.

DELETE /com.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/{prjKey}/folder/{id}
Example Response 
null


Delete a folder from a plan tree.


PARAMETERS

prjKey*

id*

The project key.

The id of the folder to delete.

POST /com.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/{prjKey}/folderissue/{id}
Example Response 
{
  	"id": 567,
  	"issueId": 12301,
  	"key": "PRJ-1",
  	"url": "http://host:port/jira/browse/PRJ-1",
  	"summary": "Example issue",
  	"icon_url": "http://host:port/jira/images/icons/issuetypes/newfeature.png",
  	"issueType": "New Feature",
  	"position": 1
}


Add an issue to a plan tree folder.


PARAMETERS

prjKey*

id*

issuekey*

The project key.

The id of the destination folder.

The key of the issue to add.

DELETE /com.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/{prjKey}/folderissue/{id}
Example Response 
null


Remove an issue from a plan tree folder.


PARAMETERS

prjKey*

id*

issuekey*

The project key.

The id of the folder to remove the issue from.

The key of the issue to be removed.

POST /com.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/{prjKey}/{plan}/folder
Example Response 
{
  	"name": "Example Folder",
  	"id": 124,
  	"parent": 123,
  	"folders": [],
  	"issues": [],
  	"position": 0
}


Create a folder under the root folder of a plan tree.


PARAMETERS

prjKey*

plan*

name*

description

The project key.

The id of the plan to create the folder in.

A name for the folder.

A description for the folder.

POST /com.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/{prjKey}/{plan}/moveissue
Example Response 
null


Move an issue from one plan tree folder to another.


PARAMETERS

prjKey*

plan*

from

to

issuekey*

The project key.

The id of the plan containing the issue that should be moved.

The id of the source folder. (Default: root)

The id of the destination folder. (Default: root)

The key of the issue to be moved.

DELETE /com.easesolutions.jira.plugins.testmanagement/1.0/tree/plan/{prjKey}/{plan}/rootissue
Example Response 
null


Remove an issue from the root folder of a plan tree.


PARAMETERS

prjKey*

plan*

issuekey*

The project key.

The id of the plan containing the issue that should be removed.

The key of the issue to be removed.