REST API: Definition Tree

Owned by Support Advocate (ease solutions)
Last updated: Feb 24, 2020 by Angelica Salazar
2 min read
GETcom.easesolutions.jira.plugins.testmanagement/1.0/tree/def/prjkey   Get the definition tree for a project.
POSTcom.easesolutions.jira.plugins.testmanagement/1.0/tree/def/prjKey/folderCreate a child folder on root in the definition tree of a project.
POSTcom.easesolutions.jira.plugins.testmanagement/1.0/tree/def/prjKey/folder/id

Create a folder under a specific parent folder in the definition tree of a project.

DELETEcom.easesolutions.jira.plugins.testmanagement/1.0/tree/def/prjKey/folder/idDelete a folder from a definition tree.
POSTcom.easesolutions.jira.plugins.testmanagement/1.0/tree/def/prjKey/folderissue/idAdd an issue to a folder in a definition tree.
DELETEcom.easesolutions.jira.plugins.testmanagement/1.0/tree/def/prjKey/folderissue/id

Remove an issue from a folder in a definition tree.

POSTcom.easesolutions.jira.plugins.testmanagement/1.0/tree/def/prjKey/moveissueMove an issue from one definition tree folder to another.
DELETEcom.easesolutions.jira.plugins.testmanagement/1.0/tree/def/prjKey/rootissueRemove an issue from the root folder of a definition tree.



GET /com.easesolutions.jira.plugins.testmanagement/1.0/tree/def/{prjkey}
Example Response 
{
	"id":-1,
	"folders": [
		"name": "Example Folder",
		"id": 123,
		"name_display": "1 Example Folder",
		"parent": -1,
		"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 definition tree for a project.


PARAMETERS

prjkey*

n

details

The project key.

Set 1 to enable auto numbering for tree folders.

Set 1 to include test steps in result.


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


Create a child folder on root in the definition tree of a project.


PARAMETERS

prjKey*

name*

description

The project key.

A name for the folder.

A description for thefolder.


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


Create a folder under a specific parent folder in the definition tree of a project.


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/def/{prjKey}/folder/{id}
Example Response 
null


Delete a folder from a definition tree.


PARAMETERS

prjKey*

id*

The project key.

The id of the folder to delete.


POST /com.easesolutions.jira.plugins.testmanagement/1.0/tree/def/{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 folder in a definition tree.


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/def/{prjKey}/folderissue/{id}
Example Response 
null


Remove an issue from a folder in a definition tree.


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/def/{prjKey}/moveissue
Example Response 
null


Move an issue from one definition tree folder to another.


PARAMETERS

prjKey*

from

to

issuekey*

The project key.

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/def/{prjKey}/rootissue
Example Response 
null


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


PARAMETERS

prjKey*

issuekey*

The project key.

The key of the issue to be removed.