Issue Interface
- Daniel Barrow
This document details the methods you can use on any Issue object, such as the one provided by the issue, linkedIssue and parentIssue variables (where applicable), as well as Issue objects returned by other methods such as getParentObject(), getEpic() or getLinkedIssues().
Methods of the Issue interface:
denotes a method that is specific to JMWE
On this page:
All methods of the Issue interface:
Methods to access issue fields and information
Method | Description | Parameters | Return type |
|---|---|---|---|
get(String fieldNameOrID) | Returns the value of a system or custom field of the Issue object. | A string representing the field name or field Id |
|
get(String fieldNameOrID, Object defaultValue) | Returns the value of a system or custom field of the Issue object. If the value is null, it returns the default value specified as the second parameter. |
|
|
getAffectedVersions | Returns a collection of Affects Version/s objects, an empty collection if there are no affects versions. | None | |
getAssignee | Returns the Assignee user, null if the issue is not assigned. | None | |
getAsJsonData(String fieldNameOrID) | Returns the JSON-style version of a system or a custom field of the Issue object, essentially a key-value Map. This can be useful to access some complex Jira Software and Jira Service desk fields. | A string representing the field name or field Id | |
getAsString(String fieldNameOrID) | Same as the | A string representing the field name or field Id |
|
getAsString(String fieldNameOrID, String defaultValue) | Same as the |
|
|
getAttachments | Returns a collection of attachment objects, an empty collection if there are no attachments. | None | |
| Returns the channel through which the Jira Service Management request was created | None | |
getComponentObjects | Returns a collection of project components (as objects) that this issue is assigned to, an empty collection if there are no components. | None | |
getCreated | Returns the timestamp of the issue creation. | None | |
getCreator | Returns the user who created the issue. | None | |
getDescription | Returns the description of the issue, | None | |
getDueDate | Returns the due date of the issue, | None | |
getEnvironment | Returns the Environment of the issue, | None | |
getEstimate | Returns the "remaining estimate" of work left to be performed on this issue, in milliseconds, | None | |
getFixVersions | Returns a collection of Fix Version/s objects, an empty collection if there are no Fix versions. | None | |
getId | Returns the ID of the issue | None | |
getIssueTypeId | Returns the ID of the issue type of the issue. | None | |
getIssueType | Returns the issue type object of the issue | None | |
getKey | Returns the key of the issue | None | |
getLabels | Returns the labels of the issue, empty Set if no labels. | None | |
getNumber | Returns the issue number in the project | None | |
getOriginalEstimate | Returns the "original estimate" of work to be performed on this issue, in milliseconds, null if empty. | None | |
getPriorityObject | Returns the Priority for this Issue. | None | |
getProjectId | Returns the ID of the Project for this Issue. |
