Skip to end of metadata
Go to start of metadata

Availability

This routine is available starting with SIL Engine™ 4.0.4.

Syntax

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

Description

Adds a new custom field option to options list for the specified context. If the context does not exist, it will be created. If the project key and issue type are not specified, the option will be added to 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).


Parameters

Parameter name

Type

Required

Description

option

string

Yes

Option to add.

fieldNamestringYesName of custom field.
projectKeystringNoProject key.
issueTypestringNoIssue type.

Return type

boolean (true/false)

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

Example

Example 1

admAddCustomFieldOption("New Option", "Select List");

Add the "New Option" to the global context of custom field "Select List".

Example 2

admAddCustomFieldOption("New Option", "Select List", "TEST", "Bug");

Add the "New Option" to custom field "Select List" with context for project "TEST" and issue type "Bug".

If already exists a context for the specified project, but not for the specified issue type, the context will not be created.

See also