admDeleteCustomFieldOption

Owned by Jonathan Muse
Last updated: Nov 20, 2024
1 min read

Description

Delete an option from the options list for the specified context. This function only handles custom fields of the following type: single select, multi select, radio buttons and checkboxes (otherwise throws an exception).

Parameters

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.

Examples

Example 1

admDeleteCustomFieldOption("Option", "Select List");

Deletes the "Option" from the global context of custom field "Select List".

Example 2

admDeleteCustomFieldOption("Option", "Select List", "TEST", "Task");

Deletes the "Option" from custom field "Select List" with context for project "TEST" and issue type "Task".

This function does not delete the context, it only deletes the specified option.

Example 3

admDeleteCustomFieldOption("Option", "Select List", {"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