| Info |
|---|
|
This routine is available starting with katl-commons 4.0.0. This routine is available for Jira server and cloud deployment options.
|
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| heading | 0 |
|---|
| columnTypes | s,s,s,s |
|---|
| multiple | false |
|---|
| columnAttributes | style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold, |
|---|
| enableSorting | false |
|---|
|
Syntax | deleteAttachment(issueKey, attachmentName) | Package | |
...
| Alias | deleteAttachment(attachmentId) | Pkg Usage | |
|
Description
| Excerpt |
|---|
|
| Deletes the attachment for a given id or for a specified issue and file name. |
Deletes the attachment for a given id or for a specified issue and file name.
Parameters
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| columnTypes | s,s,s,s |
|---|
| heading | 0 |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
Parameter name | Type | Required | Description |
|---|
issueKey | |
...
String | Yes | Issue key. | attachmentName |
|
...
String | Yes | Attachment name. | attachmentId |
|
...
Return
...
Type
boolean Boolean (true/false)
Returns "true" if the attachment was deleted successfully and "false" otherwise. If returned "false" check the log for a detailed reason on why it failed.
...
Examples
Example 1
| Code Block |
|---|
deleteAttachment(10104); |
Example 2
| Code Block |
|---|
deleteAttachment("TEST-1", "attachmentToDelete.txt"); |
...
| Note |
|---|
If you have multiple attachments on an issue with the same file name, all of them will be deleted. |
See also
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 25 |
|---|
| showSpace | false |
|---|
| cql | label = "jira_attachment_routine" and space = currentSpace ( ) |
|---|
| labels | jiraarray_attachment_routineroutines |
|---|
|