Define Parameters

To define parameters for your job, select the This project is parameterized checkbox.

It enables the Add Parameter list with the parameter types. Add as many parameters as you need.

Project Parameterized Checkbox

The parameters take effect according to their respective parameter type.

For example,

When you select the String Parameter, the corresponding parameters are added.

Define Param General Tab

The parameters are parsed dynamically at run time.

Enter the field values in the following syntax:

${ParameterName}

For the given example, the field values are ${API} and ${TestRunName}.

The system parses the parameter values according to the specified fields.

Define Param Postbuild Actions

You can also change the values before triggering the Jenkins build.

JIRA Fields

i) How to get the Custom Field ID?

Rest call to Jira to get all Jira fields.

The following URL gives the ID for all custom fields that you want to apply.

<Jira_Base_URL>/rest/api/2/field

ii) Base format for custom fields.

[{"testRun": [{}]},{"testScenario": [{}]},{"testCase": [{}]}]

iii) Standard Custom Field Types

The following types are for reference only; other types of Custom Field Types are also supported.

Custom Field Type

Validation Rule

Example

Checkboxes

The checkbox accepts comma-separated multiple values

{  "customfield_10200": [    {      "value": "true"    },    {      "value": "false"    }  ]}

Date Picker

The Date picker accepts only specified format Date

{  "customfield_10202":"2017-09-06"}

Date Time Picker

The Date time picker accepts only specified format Date and time

{  "customfield_10203": "2013-03-01T00:00:00.000+0400"}

Number Field

The Number field accepts any number with decimal

{  "customfield_10205": 2876784}

Radio Buttons

The radio button accepts single value from JIRA fields

{  "customfield_10206": {    "value": "option1"  }}

Select List (multiple choices)

The Select List Multiple accepts comma separated multiple values

{  "customfield_10208": [    {      "value": "Select List Multiple 1"    },    {      "value": "Select List Multiple 2"    }  ]}

Select List (single choice)

The radio button accepts single value from JIRA fields

{  "customfield_10209": {    "value": "Select List single 1"  }}

Text Field (multi-line)

It accepts text in multiple lines

{  "customfield_10210": "this is sample.\nexample"}

Text Field (single line)

It accepts text in single line

{  "customfield_10211": "this is sample.example"}

URL Field

It accepts Web URL

{  "customfield_10212": "http://www.url-encode-decode.com/"}

User Picker (single user)

The User field accepts only available JIRA users

{  "customfield_10213": {    "name": "admin"  }

iv) JSON Example

If you want to set 2 custom fields (checkbox, single text) on test run issue type and one custom fields (Radio Button) on scenario and test case level.

"JIRAFields":[  {    "testRun": [      {        "customfield_10200": [          {            "value": "true"          },          {            "value": "false"          }        ]      },      {        "customfield_10211": "this is sample.example"      }    ]  },  {    "testScenario": [      {        "customfield_10206": {          "value": "option1"        }      }    ]  },  {    "testCase": [      {        "customfield_10206": {          "value": "option1"        }      }    ]  }]
In this section:
© 2025
Publication date: