| Warning |
|---|
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 ! |
| Info | ||
|---|---|---|
| ||
This routine is available since katl-commons starting with SIL Engine™ 4.0.4. |
Syntax
...
admDeleteCustomFieldOption(option, fieldName[, projectKey, issueType])
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.
This routine only handles custom fields of the following types: 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
Parameter name | Type | Required | Description |
|---|---|---|---|
option | string | Yes |
Option to be deleted. | ||
| fieldName | string | Yes |
| Name of |
| custom field. | ||
| projectKey | string | No |
| Project key. | ||
| issueType | string | No |
| Issue type. |
Return type
...
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.
Example
...
Example 1
...
Delete Deletes the "Option" from the global context of custom field "Select List".
| Code Block |
|---|
admDeleteCustomFieldOption("Option", "Select List"); |
Example 2
...
Delete Deletes the "Option" from custom field "Select List" with context for project "TEST" and issue type "Task".
| Code Block |
|---|
admDeleteCustomFieldOption("Option", "Select List", "TEST", "Task"); |
See also
...
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|