deleteIssue
Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !
Availability
This routine is available starting with katl-commons 1.0.
This routine is available for Jira server and cloud deployment options.
Syntax
deleteIssue(issuekey)
Cloud Syntax
deleteIssue(issuekey, [deleteSubtasks])
Description
Deletes the selected issue.Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
issuekey | string | Yes | Key of the issue that has to be deleted. |
Cloud Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
issuekey | string | Yes | Key of the issue that has to be deleted. |
| deleteSubtasks | boolean | No | Whether the issue's subtasks are deleted when the issue is deleted. |
Return type
None. The returned value has no meaning.
Example
Example 1
deleteIssue("PRJ-323");
Result: If the current issue is not "PRJ-323" or a child of "PRJ-323", then the issue "PRJ-323" will be deleted.
Example 2
deleteIssue(key);
Result: Since "key" variable returns the key of the current issue, the delete operation will fail.
Notes
Cannot delete the current issue or the parent of the current issue.
See also