---
title: "admGetCustomFieldOptions"
canonical: "https://support.appfire.com/space/PSJ/15489447/admGetCustomFieldOptions"
format: markdown
---
> Macro (aura-html)


|  |  |  |  |
| --- | --- | --- | --- |
| **Syntax** | admGetCustomFieldOptions(fieldName, projectKeys, issueTypes [, filterDisabled]) | **Package** | adm |
| **Alias** |  | **Pkg Usage** | getCFOptions(fieldName, projectKeys, issueTypes [, filterDisabled]) |

## Description

> Macro (excerpt)
> 
> Retrieves the option list of a custom field for the specified context (projects and issue types).

Retrieves the option list of a custom field for the specified context (projects and issue types).

All parameters are required. However, if the project keys and issue types arrays are empty, the global context is used. If the **filterDisabled** parameter is used set to **true**, all disabled options are excluded from the result.

Each option is on a separate line. In case of cascading selects, the child options are prefixed by a space character.

The *new line*** **separator is system-dependent (the system can be either Windows, Mac or Linux). The line separator can be either '\n', '\r' or '\r\n'. This function only handles the following custom field types: single select, multi select, radio buttons, check boxes and cascading selects.

## Parameters

| Parameter name | Type | Required | Description |
| --- | --- | --- | --- |
| fieldName | String | Yes | Name of custom field. |
| projectKeys | String [] | No | Project keys. |
| issueTypes | String [] | No | Issue types. |
| filterDisabled | Boolean | No | Filter for disabled options. |

## Return Type

**String**

Returns a string representing the options of the specified custom field.

## Examples

### Example 1

Get the options of the **CF_CASCADE **custom field, using the global context.

```
admGetCustomFieldOptions("CF_CASCADE", {}, {});
```

Possible result as a string:

```
Parent option 1
 Child option 1
 Child option 2
Parent option 2
 Child option 1
 Child option 2
```

### Example 2

Get the options of the **CF_SELECT **custom field, using the context for projects **PRJ1** and **PRJ2** and issue types **Bug** and **Task**.

```
admGetCustomFieldOptions("CF_SELECT", {"PRJ1", "PRJ2"}, {"Bug", "Task"});
```

Possible result as a string:

```
Option 1
Option 2
Option 3
```

### Example 3

Get the options of the **CF_SELECT** custom field, using the context for projects **PRJ1** and **PRJ2** and issue types **Bug** and **Task**.

```
admGetCustomFieldOptions("CF_SELECT", {"PRJ1", "PRJ2"}, {"Bug", "Task"}, true);
```

Assuming we have three options and **Option 3** is disabled, the result should be:

```
Option 1
Option 2
```

## See also

> Macro (contentbylabel)