admDeleteCustomFieldOptions

admDeleteCustomFieldOptions

Syntax

admDeleteCustomFieldOptions(fieldName, optionsIds[, projectIssueTypesNames])

Package

adm

Alias

 

Pkg Usage

delCFOptions(fieldName, optionsIds[, projectIssueTypesNames])

Description

Deletes options with the provided ids from the custom field. This function only handles custom fields of the following types: single select, multi select, radio buttons and checkboxes.

Parameters

Parameter name

Type

Required

Description

Parameter name

Type

Required

Description

fieldName

String

Yes

Name of custom field.

optionsIds

String[]

Yes

Ids of the options to be deleted.

projectIssueTypesNames

JProjectIssueTypes []

No

An array of JProjectIssueTypes structures, representing project keys/issue types mappings. (The contexts from which to delete the options)

Return Type

boolean

The returned value has no meaning.

Example

Example

Deletes the option with id 10080 from checkbox custom field, using the context for project with key TP and issue types Bug and Task.

JProjectIssueTypes[] projectIssueTypesNames; JProjectIssueTypes map; map.projectKey = "TP"; map.issueTypesNames = {"Task", "Bug"}; projectIssueTypesNames = arrayAddElement(projectIssueTypesNames, map); return admDeleteCustomFieldOptions("checkbox", "10080", projectIssueTypesNames);

See also

Peacock

Need support? Create a request with our support team.

Copyright © 2005 - 2025 Appfire | All rights reserved.