admCreateCustomField

Availability

This routine is available starting with katl-commons 2.5.19 / 2.6.11.

Syntax

admCreateCustomField(fieldName, description, fieldType, fieldSearcher, projects, issueTypes)

Description

Creates a new custom field, offering support also for setting its context and searcher.

Parameters

Parameter name

Type

Required

Description

fieldNamestringyesCustom field name.
descriptionstringyesCustom field description (can be blank).
fieldTypestringyesCustom field type (either key or name).
fieldSearcherstringyesCustom field searcher (either key or name). If blank, the default custom field searcher for the given type will be considered.
projectsstring[]yesProjects context (project keys). If empty, global issue context will be considered.
issueTypesstring[]yesIssue types context (either names or ids). If empty, all issue types will be considered.

Parameters (Cloud)

Parameter name

Type

Required

Description

fieldNamestringyesCustom field name.
descriptionstringyesCustom field description (can be blank).
fieldTypestringyesCustom field type (key only).
fieldSearcherstringyesCustom field searcher (key only). If blank, the default custom field searcher for the given type will be considered.
projectsstring[]yesProjects context (project keys). If empty, global issue context will be considered.
issueTypesstring[]yesIssue types context (either names or ids). If empty, all issue types will be considered.

Return type

string

Returns the string id (customfield_xxxxx) of the newly created custom field.

Example

Example 1 (won't work on cloud)

Creating a single line text field with default searcher (Free Text Searcher) and global context:

admCreateCustomField("Test Field", "test description", "Text Field (single line)", "", {}, {});

Example 2 (won't work on cloud)

Creating a multi-line text field with blank description, specified searcher name (Free Text Searcher) and specified project and issue types context:

admCreateCustomField("Test Field", "", "Text Field (multi-line)", "Free Text Searcher", {"DEMO", "TEST"}, {"Bug", "Improvement"});

Example 3 (won't work on cloud)

Creating a date picker field with blank description, specified searcher key, and specified issue types ids context:

admCreateCustomField("Test Field", "", "Date Picker", "com.atlassian.jira.plugin.system.customfieldtypes:daterange", {}, {1, 2, 3});

Example 4 (cloud)

Creating a cascading select field with no specified searcher key (the default will be used) and global context:

admCreateCustomField("A cascadingselect", "cascadingselect", "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect", "", {}, {});

Example 5 (cloud)

Creating a simple text field with a specified searcher key and global context:

admCreateCustomField("Test text Field", "single line text field used to test the admin create CF", "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher", {}, {});

Example 6 (cloud)

Creating a cascading select field with no specified searcher key (the default will be used) and specific project and issue type context:

admCreateCustomField("A TJ cascadingselect", "cascadingselect", "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect", "", {"TJ"}, {"Task"});

Server only: If the provided custom field searcher key or name is wrong, it will be ignored and the custom field will be created with no searcher configured.

See also