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.
    /
    admAddCustomFieldAlias
    Updated Aug 11

    admAddCustomFieldAlias

    Syntax

    admAddCustomFieldAlias(customField, alias)

    Package

    adm

    Alias

     

    Pkg Usage

    addCFAlias(customField, alias)

    Description

    Adds a custom field alias in the sil.aliases file.

    Parameters

    Parameter name

    Type

    Required

    Description

    Parameter name

    Type

    Required

    Description

    customField

    String

    Yes

    Custom field string id, name or existing alias.

    alias

    String

    Yes

    New custom field alias to set.

    Return Type

    Boolean (true/false)

    Returns 'true' if the custom field alias was added successfully in the sil.aliases file or already exists and 'false' otherwise.

    Examples

    Example 1

    Setting a custom field alias using custom field id:

    admAddCustomFieldAlias("customfield_10000", "TestAlias");

    Example 2

    Setting a custom field alias using custom field name:

    admAddCustomFieldAlias("Text Field", "TestAlias");

    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": 31, "requestCorrelationId": "0ba53153c6bd42779170a51814fb3511"}