View Source

com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/foldertree/id

GET	com.easesolutions.jira.plugins.requirement1s/1.0/search/prjKey	Search for project tree folders and retrieve detailed information for the found elements.
GET	com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey	Get the complete project tree structure for a given project.
POST	com.easesolutions.jira.plugins.requirements/1.0/tree/reuse	Trigger a requirements reuse. Source and target may be in different projects.
POST	com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/createscheduledjob	Allows the creation of jobs for the scheduled adding of existing issues.
GET	com.easesolutions.jira.plugins.requirements/1.0/tree/totalItemCount/prjKey	Returns total item count of project tree.

GET	com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folders	Get complete tree structure of project.
GET	com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/foldertree/id	Get complete tree structure with or without issues for certain project tree folder.
POST	com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folder	Create a new project tree folder below the root folder of a given project.
POST	com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folder/id	Create a new project tree folder below a specified folder of a given project.
PUT	com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folder/id	Rename a folder using project key.
DELETE	com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folder/id	Delete a project tree folder from a given project.

POST	com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/rootissue	Add an existing issue to the root folder of a given project.
DELETE	com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/rootissue	Remove an issue from the root folder of a given project.
POST	com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folderissue/id	Add an existing issue to a specified tree folder of a given project.
DELETE	com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folderissue/id	Remove an issue from a specified tree folder of a given project.
POST	com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/moveissue	Move an issue from one tree folder to another one of the same project.

GET	com.easesolutions.jira.plugins.requirements/1.0/child-req/prjKey/parentKey	Get all child requirements for a given issue in a specific project.
POST	com.easesolutions.jira.plugins.requirements/1.0/child-req/prjKey/parentKey	Add a child requirement to an issue in the project tree a given project.
DELETE	com.easesolutions.jira.plugins.requirements/1.0/child-req/prjKey/parentKey	Remove a child requirement from an issue in the project tree of a given project.

Search for project tree folders and retrieve detailed information for the found elements.

REQUEST

GET

/rest/com.easesolutions.jira.plugins.requirements/1.0/search/prjKey?type&pathSep&path

PARAMETERS

parameter	type	description
prjKey*	string	the project key
type	string	itemtype to search for (should be "folder")
pathSep	string	seperator chars used in path (default "/")
path	string	the path to search in

RESPONSES

- Returned if tree element is found

{
  	"folders": [
    	{
      		"name": "First",
      		"id": 9,
      		"name_display":"First",
      		"parent": -1,
      		"folders": [
        		{
          			"name": "Second",
          			"id": 14,
          			"name_display":"Second",
          			"parent": 9,
          			"folders": [],
          			"issues": [],
          			"position": 2
        		},
      		],
      		"issues": [],
      		"position": 3
    	}
  	],
  	"issues": []
}

- Returned if the project is invalid, type is invalid, the path separator is invalid or path is invalid

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Get the complete project tree structure for a given project.

REQUEST

GET

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey?n

PARAMETERS

parameter	type	description
prjKey*	string	the project key
n	string	toggles structure numbering prefix for folder names (0 = disabled (default), 1 = enabled)

RESPONSES

- Returned if tree structure of an existing project is found

{
  	"id": -1,
  	"folders": [
		{
      		"name": "First",
      		"id": 56,
      		"name_display": "First",
      		"parent": -1,
      		"folders": [
        		{
          			"name": "Third",
          			"id": 69,
          			"name_display": "Third",
          			"parent": 56,
          			"folders": [],
          			"issues": [
            			{
              				"id": 132,
              				"issueId": 10157,
              				"key": "AN-4",
              				"url": "http://<server-name>/browse/AN-4",
              				"summary": "Second",
              				"description": "Issue number 61",
              				"icon_url": "http://<server-name>/images/icons/issuetypes/newfeature.png",
              				"issueType": "New Feature",
              				"position": 1
            			},
            			{
              				"id": 131,
              				"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": 2
            			}
          			],
         			"position": 1
        		}
			],
    		"issues": [],
    		"position": 1
		},
		{
			"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": 2
		},
		{
			"name": "Root",
			"id": 75,
			"name_display": "Root",
			"parent": -1,
			"folders": [],
			"issues": [],
			"position": 3
		},
		{
			"name": "Test",
			"id": 70,
			"name_display": "Test",
			"parent": -1,
			"folders": [],
			"issues": [],
			"position": 4
		}
	],
	"issues": []
}

- Returned if the project is invalid

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Trigger a requirements reuse. Source and target may be in different projects.

REQUEST

POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/reuse?source&target&ruleName

PARAMETERS

parameter	type	description
source	string	the source folder for reuse (e.g. Requirements Plugin/Implementation)
target	string	the target folder for the reuse (e.g. Requirements Plugin/Features/Baseline/Permissions)
ruleName	string	the name of a reuse rule (e.g. "rule 27")

RESPONSES

- Returned if requirement is successfully reused

Reuse Success

- Returned if source folder is invalid, source project is invalid, target folder is invalid, target project is invalid, the reuse rule name is invalid or an error occurs while processing reuse

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Allows the creation of jobs for the scheduled adding of existing issues.

REQUEST

POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/createscheduledjob?name&folderId&filter&interval

PARAMETERS

parameter	type	description
prjKey*	string	the project key of the project
name	string	the name of the scheduled job
folderId	long	the folder id of the tree folder
filter	string	the JQL, JIRA filter, or if null will default to add all issues from the project that have not added to the project tree
interval	long	the time interval in minutes. Enter 0 as value to set execution interval to Manual.

RESPONSES

- Returned if jobs for the scheduled adding of existing issues is succesfully created

Rule Home Page UI req has been successfully created

- Returned if the project is invalid, the name is invalid or already exists, the folder is invalid, the filter is invalid or interval is less than zero

- Returned if invalid user credentials, or the user has no permission to use the Requirements for JIRA plugin

- Returned if the license is invalid or has expired, incompatible JIRA version, or no permission to create jobs for the scheduled adding of existing issues

- Returned if folder is not found

Returns all tree folders and subfolders in project.

REQUEST

GET

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folders

PARAMETERS

parameter	type	description
prjKey*	string	project key of folders to be return

RESPONSES

- Returned if tree structure if an existing project is found

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

- Returned if the project is invalid

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Get complete tree structure with or without issues for certain project tree folder.

REQUEST

GET

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/foldertree/id?folderOnly&n

PARAMETERS

parameter	type	description
prjKey*	string	the project key
id*	string	the folder id
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)

RESPONSES

- Returned if tree structure if an existing project is found

{
  	"id": 1,
  	"folders": [
		{
      		"name": "First",
      		"id": 56,
      		"name_display": "First",
      		"parent": -1,
      		"folders": [
        		{
          			"name": "Third",
          			"id": 69,
          			"name_display": "Third",
          			"parent": 56,
          			"folders": [],
          			"issues": [
            			{
              				"id": 132,
              				"issueId": 10157,
              				"key": "AN-4",
              				"url": "http://<server-name>/browse/AN-4",
              				"summary": "Second",
              				"description": "Issue number 61",
              				"icon_url": "http://<server-name>/images/icons/issuetypes/newfeature.png",
              				"issueType": "New Feature",
              				"position": 1
            			},
            			{
              				"id": 131,
              				"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": 2
            			}
          			],
         			"position": 1
        		}
			],
    		"issues": [],
    		"position": 1
		},
		{
			"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": 2
		},
		{
			"name": "Root",
			"id": 75,
			"name_display": "Root",
			"parent": -1,
			"folders": [],
			"issues": [],
			"position": 3
		},
		{
			"name": "Test",
			"id": 70,
			"name_display": "Test",
			"parent": -1,
			"folders": [],
			"issues": [],
			"position": 4
		}
	],
	"issues": []
}

- Returned if the project is invalid

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Create a new project tree folder below the root folder of a given project.

Returns information about the new folder in case of success.

REQUEST

POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folder?name&description

PARAMETERS

parameter	type	description
prjKey*	string	the project key
name	string	the name of the new folder
description	string	optional description of the new folder

RESPONSES

- Returned if the folder is successfully created

{
  "name": "Test",
  "id": 76,
  "parent": -1,
  "folders": [],
  "issues": [],
  "position": 0
}

- Returned if the project is invalid, name is invalid or already exists, or an error occurs in folder creation

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Create a new project tree folder below a specified folder of a given project.

Returns information about the new folder in case of success.

REQUEST

POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folder/id?name&description

PARAMETERS

parameter	type	description
prjKey*	string	the project key
id*	string	the ID of the parent folder
name	string	the name of the new folder
description	string	optional description for the new folder

RESPONSES

- Returned if the folder is successfully created

{
  "name": "Child",
  "id": 77,
  "parent": 76,
  "folders": [],
  "issues": [],
  "position": 0
}

- Returned if the project is invalid, the folder is invalid, name is invalid or already exists, or an error occurs in folder creation

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Renames folder using project key.

REQUEST

PUT

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folder/id

Sample request data JSON:
{
"name": "sample name"
}


name (string): The folder's new name if operation is successful.

PARAMETERS

parameter	type	description
prjKey*	string	the project key
id*	string	the ID of the folder to be renamed
data	object	The JSON object of the new folder. Please refer above for the example and properties definition.

RESPONSES

- Returned if the folder is successfully renamed

- Returned if the project is invalid, or the folder id is invalid

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Delete a project tree folder from a given project.

REQUEST

DELETE

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folder/id

PARAMETERS

parameter	type	description
prjKey*	string	the project key
id*	string	the ID of the folder to be deleted

RESPONSES

- Returned if the folder is successfully deleted

- Returned if the project is invalid, or the folder id is invalid

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Add an existing issue to the root folder of a given project.

REQUEST

POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/{prjKey}/rootissue

QUERY PARAMETERS

parameter	type	description
issuekey	string	the key of the issue to be associated

RESPONSES

- Returned if issue is added to root folder

{
  	"id": 136,
  	"issueId": 0,
  	"key": "",
  	"url": "",
  	"summary": "",
  	"description": "",
  	"issueType": "",
  	"position": 0,
  	"childReqs": {
    	"childReq": []
  	}
}

- Returned if the project is invalid, or an error occurs while adding the issue to the root folder

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Remove an issue from the root folder of a given project.

REQUEST

DELETE

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/rootissue?issuekey

PARAMETERS

parameter	type	description
prjKey*	string	the project key
issuekey	string	the key of the issue whose association should be removed

RESPONSES

- Returned if issue is deleted from root folder

- Returned if the project is invalid, or an error occurs while removing the issue from the root folder

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Add an existing issue to a specified tree folder of a given project.

REQUEST

POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folderissue/id?issuekey

PARAMETERS

parameter	type	description
prjKey*	string	the project key
id*	string	the folder ID
issuekey	string	the key of the issue to be associated

RESPONSES

- Returned if issue is associated to the folder

{
  	"id": 136,
  	"issueId": 0,
  	"key": "",
  	"url": "",
  	"summary": "",
  	"description": "",
  	"issueType": "",
  	"position": 0,
  	"childReqs": {
    	"childReq": []
  	}
}

- Returned if the project is invalid, the folder id is invalid, or an error occurs while adding the issue to the folder

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Remove an issue from a specified tree folder of a given project.

REQUEST

DELETE

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/folderissue/id?issuekey

PARAMETERS

parameter	type	description
prjKey*	string	the project key
id*	string	the folder ID
issuekey	string	the key of the issue whose association should be removed

RESPONSES

- Returned if issue association is removed from the folder

- Returned if the project is invalid, the folder id is invalid, or an error occurs while removing the issue from the folder

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Move an existing issue association to a new folder

Returns ok in case of success

REQUEST

POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/prjKey/moveissue?from&to&issuekey&pos

PARAMETERS

parameter	type	description
prjKey*	string	the project key
from	string	the ID of the source folder (if source folder is root, ID may be blank or -1)
to	string	the ID of the destination folder (if destination folder is root, ID may be blank or -1)
issuekey	string	the key of the issue whose association should be moved
pos	string	optional position of the issue in the destination folder (currently not supported)

RESPONSES

- Returned if issue association is moved to the new folder

- Returned if the project is invalid, the from folder id is invalid, the to folder id is invalid, or an error occurs while moving the issue

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Get all child requirements for a given issue in a specific project.

REQUEST

GET

/rest/com.easesolutions.jira.plugins.requirements/1.0/child-req/prjKey/parentKey

PARAMETERS

parameter	type	description
prjKey*	string	the project key
parentKey*	string	key of the parent issue

RESPONSES

- Returned if child requirements of a given issue key is found

{
  "childReq": [
    {
      "issueId": 10154,
      "key": "AN-1",
      "url": "http://<server-name>/jira/browse/AN-1",
      "summary": "First",
      "icon_url": "http://<server-name>/images/icons/issuetypes/newfeature.png",
      "issueType": "New Feature",
      "position": 1
    }
  ]
}

- Returned if the parent key is invalid

- Returned if the project is invalid, invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Add a child requirement to an issue in the project tree a given project.

Note that the child requirement can't be already part of the project.

REQUEST

POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/child-req/prjKey/parentKey?childKey

PARAMETERS

parameter	type	description
prjKey*	string	the project key
parentKey*	string	key of the parent issue
childKey	string	key of the child issue

RESPONSES

- Returned if a child requirement to an issue is added

{
  "childReq": [
    {
      "issueId": 10154,
      "key": "AN-1",
      "url": "http://<server-name>/jira/browse/AN-1",
      "summary": "First",
      "icon_url": "http://<server-name>/images/icons/issuetypes/newfeature.png",
      "issueType": "New Feature",
      "position": 1
    }
  ]
}

- Returned if the parent key is invalid, child key is invalid, or the child requirement is already part of the project tree

- Returned if the project is invalid, invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Remove a child requirement from an issue in the project tree of a given project.

REQUEST

DELETE

/rest/com.easesolutions.jira.plugins.requirements/1.0/child-req/prjKey/parentKey?childKey

PARAMETERS

parameter	type	description
prjKey*	string	the project key
parentKey*	string	key of the parent issue
childKey	string	key of the child issue

RESPONSES

- Returned if a child requirement to an issue is removed

- Returned if the parent or child key is invalid

- Returned if the project is invalid, invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version

Get total item count in project tree with option to include or exclude pages in count.

REQUEST

GET

/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/totalItemCount/prjKey

PARAMETERS

parameter	type	description
prjKey*	string	the project key
includePages	boolean	option to include pages in total count; where default value is true. if value is set to false, only issues will be counted

RESPONSES

- Returned if project key is valid

{ "totalItemCount": 125 }

- Returned if the project is invalid, type is invalid, the path separator is invalid or path is invalid

- Returned if invalid user credentials, or the user has no permission

- Returned if the license is invalid or has expired, or incompatible JIRA version