Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleAvailability

This routine is available since starting with katl-commons 4.0.4.

Syntax

...

admDeleteCustomFieldOption(option, fieldName[, projectKey, issueType])

Description

...

Excerpt

Delete an option from the options list for the specified context.

...

Note

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


Parameters

...

Parameter name

Type

Required

Description

option

string

Yes

The option to be deleted

fieldNamestringYesThe name of the custom field
projectKeystringNoThe project key
issueTypestringNoThe issue type

Return type

...

boolean (true/false)

Returns true if the option was deleted successfully, false otherwise. If returned false check the log for a detailed reason on why it failed.

Example

...

Example 1

...

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

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


Example 2

...

Delete 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)
showLabelsfalse
showSpacefalse
cqllabel = "jira_field_routine"
labelsjira_attachment_routine