admGetCustomFieldOptions

Description

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 routine only handles the following custom field types: single select, multi select, radio buttons, check boxes and cascading selects.

Parameters

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"});