getAvailableOptions(String fieldNameOrID)
- Daniel Barrow
The getAvailableOptions(String fieldNameOrID) method 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(), returns a collection of available options for the specified field. The return type depends on the field specified. For example, a version picker type field returns a Collection<Version>, the Component/s field returns a Collection<ProjectComponent>, etc.
To find the available options for a field, say, Affects Version/s, call this method on the current issue using either the field name or the field ID, just like on the get(String fieldNameOrID) method: issue.getAvailableOptions("Affects Version/s") or issue.getAvailableOptions("versions")
Dynamic fields like Description, Summary, Labels etc are not supported in this method. If you try passing these fields you will get an error.
See here for this method's use case.
On this page:
Supported Standard Jira fields
| Field Name | Field ID | Returns |
|---|---|---|
| Affects Version/s | versions | Collection<Version> |
| Component/s | components | Collection<ProjectComponent> |
| Fix Version/s | fixVersions | |
| Priority | priority | Collection<Priority> |
| Resolution | resolution | |
| Security Level | security | |
Supported Custom fields
A custom field available options display is decided by the custom field type implementation.
'xxxxx' in the custom fields detailed below is the ID of the custom field. Click here to know how to find the ID of custom fields.
| Field Name | Returns |
|---|---|
Checkboxes / Multi-select list / Radio buttons / Single-select list / Cascading | Collection<Option> |
Single Version picker / Multi-version picker | |
| Project picker | |