This document lists the expected text/raw input value that should be provided to set Jira Standard and Custom fields. The easiest is to use the "Expected Value" tab of the Groovy editor help system. It lists the possible expected values for the selected Field and Value Type. This is applicable in contexts where you set a field value or comment an issue or write a conditional Groovy script. Select the Field and Value Type as Set field value to constant or Groovy template. Click on Expected Value. The help editor displays the expected text/Groovy templates values for the selected field.
You might also want to look at Standard fields, Predefined custom fields, and User-created custom fields to know how to access the fields of an issue object.
...
Field Name | Expected input value | Examples |
|---|
| Affects Version/s | - Version name or id (id takes precedence over the name) should be provided
- To set multiple values, you should provide version names or ids (idtakes precedence over the name) separated by a comma.
| |
| Assignee | Any of the following user detail should be provided: - Username
- Email address
- Full name
| Note |
|---|
It is recommended you use Username(s) because Email address(es) and Full name(s) are not unique in Jira. |
| |
| Component/s | - Component name or id (idtakes precedence over the name) should be provided
- To set multiple values, you should provide component names or ids (id takes precedence over the name) separated by a comma.
| |
| Description | Any simple single/multi-line text should be provided | TestTesting of
First project
Second project
|
| Due Date | String representing a timestamp in theformat specified in Jira system settings. | |
| Environment | Any simple single/multi-line text should be provided | |
| Fix Version/s | - Version name or id (id takes precedence over the name) should be provided
- To set multiple values, you should provide version names or ids (id takes precedence over the name) separated by a comma
| |
| Issue type |
| Note |
|---|
Use with caution! Changing the issue type should only be done if the current and new issue types share the same workflow, or if the issue's Status exists in both the current and new workflow. Otherwise, the operaton will fail. Also, when changing the issue type of the current issue, make sure to move the post-function below the "Set issue status to the linked status of the destination workflow step" built-in post-function. |
String representing the issue type name or id | |
| Labels | - String representing a label should be provided.
- To set multiple labels, you should provide values separated by space.
| NewLabelLabel1 Label2 Label3
|
| Original Estimate | Number representing the estimate in seconds or a duration string should be provided. | |
| Priority | Priority name or id (id takes precedence over the name) should be provided | |
| Remaining Estimate | Number representing the estimate in seconds or a duration string should be provided. | |
| Reporter | Any of the following user detail should be provided: Email address| Note |
|---|
It is recommended you use Username(s) because |
| |
| Resolution | Resolution name or ID (id takes precedence over the name) should be provided | |
| Security level | Security level name or id (id takes precedence over the name) should be provided | |
| Status |
| Note |
|---|
Use with caution! Changing the Status of an issue is normally done only through an issue transition. Changing the Status field value directly will not validate potentially required fields (such as the Resolution field), and will leave no trace in the issue history. This should be used only in specific cases. Also, when changing the Status of the current issue, make sure to move the post-function below the "Set issue status to the linked status of the destination workflow step" built-in post-function. Finally, the Status field cannot be set during a Create transition. |
String representing the status name or status id Open10020 | |
| Summary | Any simple single/multi-line text should be provided | This is the summary of the issue
|
| Time Spent | Number representing the time spent in seconds or a duration string should be provided. | |
| Votes | | Note |
|---|
It is recommended you use Username(s) because Email address(es) and Full name(s) are not unique in Jira. |
| |
| Watchers | | Note |
|---|
It is recommended you use Username(s) because Email address(es) and Full name(s) are not unique in Jira. |
| |
Pre-defined custom fields
...
Field Name | Expected input value | Examples |
|---|
| Epic Color | Any simple single/multi-line text should be provided | ghx-label-6
|
| Epic Link | Issue KEY of an Epic should be provided | |
| Epic Name | Any simple single/multi-line text should be provided | Creation of a new issue
|
| Epic Status | Status value should be provided | |
| Sprint | String representing the ID of the sprint should be provided. | 1
|
| Story points | String representing the number of story points should be provided | 5
|
Jira Service Desk fields
Field Name | Expected input value | Examples |
|---|
| Approvers | | Note |
|---|
It is recommended you use Username(s) because Email address(es) and Full name(s) are not unique in Jira. |
|
|
| Customer Request Type | - Customer Request Type name or internal ID
| - IT help
sd/desktoplaptopsupport
|
| Organizations | - Organization name ID should be provided.
- To set multiple values, you should provide the Organization names or IDs separated by a comma.
| |
| Request Participants | | Note |
|---|
It is recommended you use Username(s) because Email address(es) and Full name(s) are not unique in Jira. |
|
|
...