| Info |
|---|
|
This routine is available starting with SIL Engine™ 4.0.4. |
Syntax
...
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| heading | 0 |
|---|
| columnTypes | s,s,s,s |
|---|
| multiple | false |
|---|
| columnAttributes | style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold, |
|---|
| enableSorting | false |
|---|
|
Syntax | admDeleteCustomFieldOption(option, fieldName[, projectKeys, issueTypes]) | Package | adm | Alias | | Pkg Usage | delCFOption(option, fieldName[, |
|
...
...
Description
| Excerpt |
|---|
|
Delete an option from the options list for the specified context. |
If the project key and issue type are not specified, the option will be deleted from the global context.
Delete an option from the options list for the specified context. This routine only handles custom fields of the following typestype: single select, multi select, radio buttons and checkboxes (otherwise throws an exception).
| Note |
|---|
This routine does not delete the context, it only deletes the specified option. |
...
Parameters
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| columnTypes | s,s,s,s |
|---|
| heading | 0 |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
Parameter name | Type | Required | Description |
|---|
option |
|
...
String | Yes | Option to be deleted. | fieldName |
|
...
String | Yes | Name of custom field. |
|
...
...
...
...
...
...
Return
...
Type
boolean Boolean (true/false)
Returns 'true' if the option was deleted successfully and 'false' otherwise. If returned 'false' check the log for a detailed reason on why it failed.
...
Examples
Example 1
| Code Block |
|---|
admDeleteCustomFieldOption("Option", "Select List"); |
Deletes the "Option" from the global context of custom field "Select List".
Example 2
| Code Block |
|---|
admDeleteCustomFieldOption("Option", "Select List", "TEST", "Task"); |
...
Deletes the "Option" from custom field "Select List" with context for project "TEST" and issue type "Task".
| Note |
|---|
This routine does not delete the context, it only deletes the specified option. |
Example 3
| Code Block |
|---|
admDeleteCustomFieldOption("Option", "Select List", "TEST"{"TEST1", "TEST2"}, {"Task", "Story"}); |
Deletes the "Option" from custom field "Select List" with context for projects "TEST1", “TEST2” (must be an uniquely identified context) and issue types "Task", “Story”.
See also
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 25 |
|---|
| showSpace | false |
|---|
| cql | label = " |
|---|
|
...
...
| admin_routine" and space = currentSpace ( ) | | labels |
|---|
|
...
...