| Info | ||
|---|---|---|
| ||
This routine is available starting with SIL Engine™ 4.6.3. |
| Table plus | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
Description
| 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, but if the project keys and issue types arrays are empty, the global context is going to be used.
Each option will reside on a separate line. In case of cascade selects, the child options will be prefixed with a space character.
The new line separator is system dependent (where the system can be Windows, Mac or Linux. The line separator can be either '\n', '\r' or '\r\n'.
This routine only handles custom fields of the following types: single select, multi select, radio buttons, checkboxes and checkboxes and cascading selects.
Parameters
| Table plus | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
|
...
|
...
|
Return
...
Type
stringString
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.
| Code Block |
|---|
admGetCustomFieldOptions("CF_CASCADE", {}, {});
|
Possible result as a string:
| Code Block |
|---|
Example 2
Get the options of the "CF_
...
SELECT" custom field, using the
...
Possible result as a string:
| Code Block |
|---|
Parent option 1
Child option 1
Child option 2
Parent option 2
Child option 1
Child option 2
|
...
context for projects "PRJ1" and "PRJ2" and issue types "Bug" and "Task".
| Code Block |
|---|
admGetCustomFieldOptions("CF_SELECT", {"PRJ1", "PRJ2"}, {"Bug", "Task"}); |
...
Possible result as a string:
| Code Block |
|---|
See also
| Filter by label (Content by label) | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|