Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Teams
, (opens new window)

Power Scripts for Jira Cloud
Results will update as you type.
  • Get started
  • Configuration guides
  • Integration guides
  • Feature guides
  • Advanced features
  • Migration resources
  • Simple Issue Language
    • Getting started with SIL
    • SIL reference guide
    • SIL Functions library
      • Function Index
      • Packages
      • Array Functions
      • Basic Functions
      • Date and Interval Functions
      • Excel Functions
      • File Manipulation Functions
      • HTTP Functions
      • Incoming Mail Processing Functions
      • Integration with Other Systems
      • Jira Administration Functions
        • Custom Field Administration Functions
          • admAddCustomFieldAlias
          • admAddCustomFieldOptions
          • admCreateCustomField
          • admDeleteCustomField
          • admDeleteCustomFieldOptions
          • admGetCustomFieldOptions
          • admReloadCustomFieldAliases
          • admUpdateCustomField
          • admUpdateCustomFieldOptions
          • getContextsForCustomField
          • getIssueTypesInCustomFieldContext
          • getProjectsInCustomFieldContext
          • getIssueTypesInTheSameContext
        • Dashboard Functions
        • Field Configuration Functions
        • Filter Administration Functions
        • Group Administration Functions
        • Issue Administration Functions
        • Issue Type & IT Screen Scheme Administration Functions
        • Notification Administration Functions
        • Permissions Administration Functions
        • Priority Scheme Administration Functions
        • Project Administration Functions
        • Screen and Screen Schemes Administration Functions
        • System Administration Functions
        • User Administration Functions
      • Jira Integration Functions
      • Jira Service Management Functions
      • Jira Software Functions
      • Listener Functions
      • Math Functions
      • Parameter Functions
      • Scheduling Functions
      • String Functions
      • System Integration
      • Webhooks Functions
  • Tutorials and recipes
  • Jira Product Discovery support
  • Release notes
  • Help and support
    You‘re viewing this with anonymous access, so some content might be blocked.
    /
    admAddCustomFieldOptions
    Updated Aug 11

    admAddCustomFieldOptions

     

    Syntax

    admAddCustomFieldOption(fieldName, options[, projectIssueTypesNames])

    Package

    adm

    Alias

     

    Pkg Usage

    addCFOption(fieldName, options[, projectIssueTypesNames])

    Description

    Adds new custom field options (JCustomFieldOption[]) to options list 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

    Parameter name

    Type

    Required

    Description

    fieldName

    String

    Yes

    Name of custom field.

    options

    JCustomFieldOption[]

    Yes

    Options to be added, as a JCustomFieldOption array. The id parameter is not needed and will be ignored, value can't be empty.

    projectIssueTypesNames

    JProjectIssueTypes []

    No

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

    Return Type

    JCustomFieldOption[]

    Returns an array of JCustomFieldOption structures representing the options added to the specified custom field.

    Example

    Example

    Adding an option to 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[] optionsToBeAdded; JCustomFieldOption option; option.value = "added from SIL"; optionsToBeAdded = arrayAddElement(optionsToBeAdded, option); JCustomFieldOption[] customFieldOptions = admAddCustomFieldOptions("checkbox", optionsToBeAdded, 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 options added, now with ID's.

    See also

    • Page:
      admUpdateCustomField
    • Page:
      admGetCustomFieldOptions
    • Page:
      admDeleteCustomField
    • Page:
      admAddCustomFieldOptions
    • Page:
      admDeleteCustomFieldOptions
    • Page:
      admUpdateCustomFieldOptions
    • Page:
      admAddCustomFieldAlias
    • Page:
      admCreateCustomField
    Peacock

    Need support? Create a request with our support team.

    Copyright © 2005 - 2025 Appfire | All rights reserved.

    {"serverDuration": 13, "requestCorrelationId": "8da05883ccc940bba46a026347129795"}