getFieldOptions
- Service Account
- Jonathan Muse
- Elena Kolesnik
- Cristian Pintea (Unlicensed)
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 SIL Engine™ 3.0.
Syntax
getFieldOptions(projectKey, issueType, fieldName)
Starting from SIL Engine™ 4.5.0:
getFieldOptions(projectKey, issueType, fieldName [, hideDisabledOptions])
Description
Returns a string array representing the list of options for a custom field.Starting from SIL Engine™ 4.5.0 it was enhanced with the "hideDisabledOptions" boolean flag which, when set to true, filters the disabled options from the result so only the active options will be returned.
This routine only handles custom fields of the following types: single select, multi select, radio buttons and checkboxes, otherwise throws an exception.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
project key | String | Yes | Key of the selected project. |
issue type | String | Yes | Type of the selected issue. |
field name | String | Yes | Name of the selected field. |
| hideDisabledOptions | boolean | No | Flag to be set when searching for just the active options. |
Return type
string[]
The returned string array represents the list of options for a custom field.
Example
getFieldOptions("DEMO", "Bug", "RB - BUG");
Gets the options for a custom field named "RB - BUG", that exists in the project with the key "DEMO" and has its issue type "BUG".
See also