Our new Appfire Documentation Space is now live!

Take a look here! If you have any questions please email support@appfire.com

getAvailableOptions(String fieldName)

The getAvailableOptions(String fieldName) method on any Issue object, such as the one provided by the issue, 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(<field_name> or <field_id>) method: issue.getAvailableOptions("Affects Version/s") or issue.getAvailableOptions("versions")

(warning) Dynamic fields like Description, Summary, Labels etc are not supported in this method. If you try passing these fields you will get an error.

On this page:

Supported Standard Jira fields

Field NameField IDReturns
Affects Version/sversions
Collection<Version>
Component/scomponentsCollection<ProjectComponent>
Fix Version/sfixVersions
Collection<Version>
PrioritypriorityCollection<Priority>
Resolutionresolution
Collection<Resolution>
Security Levelsecurity
Collection<IssueSecurityLevel>

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 NameReturns

Checkboxes / Multi-select list / Radio buttons / Single-select list / Cascading

Collection<Option>

Single Version picker / Multi-version picker

Collection<Version>
Project picker
Collection<Project>