admUpdateCustomFieldOptions
Syntax | admUpdateCustomFieldOptions(fieldName, options[, projectIssueTypesNames]) | Package | adm |
Alias |
| Pkg Usage | updateCFOptions(fieldName, options[, projectIssueTypesNames]) |
Description
Update custom field options (JCustomFieldOption[]) for the specified context. If the context does not exist, it will NOT be created. This function only handles custom fields of the following types: single select, multi select, radio buttons and checkboxes.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
fieldName | String | Yes | Name of custom field. |
options | JCustomFieldOption[] | Yes | Options to be updated, as a JCustomFieldOption array. The id parameter is required, value can't be empty. |
projectIssueTypesNames | JProjectIssueTypes [] | No | An array of JProjectIssueTypes structures, representing project keys/issue types mappings. (The contexts in which to update the options) |
Return Type
Returns an array of JCustomFieldOption structures representing the options updated to the specified custom field.
Example
Example
Updating an option of the 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);
JCustomFieldOption[] optionsToBeUpdated;
JCustomFieldOption option;
option.id = "10076";
option.value = "updated from SIL";
option.disabled = "true";
optionsToBeUpdated = arrayAddElement(optionsToBeUpdated, option);
JCustomFieldOption[] customFieldOptions = admUpdateCustomFieldOptions("checkbox", optionsToBeUpdated, projectIssueTypesNames);
int indexCC = 1;
for(JCustomFieldOption option in customFieldOptions) {
runnerLog("---option " + indexCC + "---");
runnerLog("id = " + option.id);
runnerLog("optionId = " + option.optionId);
runnerLog("value = " + option.value);
runnerLog("disabled = " + option.disabled);
indexCC = indexCC + 1;
}
runnerLog("_________________________________________________");The result will contain the updated options.
See also
Need support? Create a request with our support team.
Copyright © 2005 - 2025 Appfire | All rights reserved.