DATA CENTER AND SERVER | CLOUD
REST API: Tree Child Issues
- Angelica Salazar
- Niel Flores
Gets all child requirements for a given issue in a specific project
Request
PATH PARAMETERS
parameter | type | description |
---|
parameter | type | description |
---|---|---|
prjKey | string | project key |
parentKey | string | issuekey of parent issue |
Sample Request Path
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/child-req/ABCD/ABCD-100
Responses
status 200 application/json Returned if successful.
Example
{
"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
}
]
}
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.
Adds a child requirement to an issue in the project tree of a given project
Note that the child requirement can't be already part of the project.
Request
PATH PARAMETERS
parameter | type | description |
---|
parameter | type | description |
---|---|---|
prjKey | string | project key |
parentKey | string | issuekey of parent issue |
QUERY PARAMETERS
parameter | type | description |
---|
parameter | type | description |
---|---|---|
childKey | string | issuekey of child issue to be added to the parentKey |
Sample Request Path
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/child-req/ABCD/ABCD-100?childKey=ABCD-250
Responses
status 200 application/json Returned if successful.
Example
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.
Removes a child requirement from an issue in the project tree of a given project
Note that the child requirement will only be removed from the tree and not deleted from Jira.
Request
PATH PARAMETERS
parameter | type | description |
---|
parameter | type | description |
---|---|---|
prjKey | string | project key |
parentKey | string | issuekey of parent issue |
QUERY PARAMETERS
parameter | type | description |
---|
parameter | type | description |
---|---|---|
childKey | string | issuekey of child issue to be removed |
Sample Request Path
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.