This document lists the expected JSON input value that should be provided to set Jira Standard and Custom fields. You might also want to look at Standard Jira fields, Predefined Custom fields and User-created custom fields to know how to access the fields of an issue.
On this page:
Table of Contents |
---|
Standard Jira fields
...
[{"name":"2.0"}]
[{"name":"2.0"},{"name":"1.0"}]
{{issue.fields.fixVersions | dump}} -
Using Nunjucks annotations to copy the Fix Versions
...
{"accountId":"
"}accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e
{{issue.fields.reporter | dump}} -
Using
Nunjucks annotations to copy the Reporternull
...
[{"content":"http://www.innovalog.com/images/atlassianverified-box.png"}]
...
This document lists the expected JSON input value that should be provided to set Jira Standard and Custom fields. You might also want to look at Standard Jira fields, Predefined Custom fields and User-created custom fields to know how to access the fields of an issue.
On this page:
Table of Contents
Standard Jira fields
Account ID or name
2
"NewYork Account"
[{"accountId
":"accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e
"}]
accountId
":"accountId:557058:Field Name | Expected input type | Expected input value | Example | |||||
---|---|---|---|---|---|---|---|---|
Affects Version/s | An array of objects | Version object |
| |||||
Description | String | Any simple single/multi-line text within quotes should be provided. |
| |||||
Due date | String | String containing an ISO_8601 date within quotes should be provided. |
| |||||
Environment | String | Any simple single/multi-line text within quotes should be provided. |
| |||||
| ||||||||
Assignee | Object | User object, or null for Unassigned |
| |||||
Attachments | An array of objects | Attachment object |
| |||||
Component/s | An array of objects | Version Component object |
| |||||
Issue TypeDescription | Object | Issue Type object |
| Labels | Array of values | Value String | Any simple single/multi-line text within quotes should be provided. |
|
Due date | String | String containing an ISO_8601 date within quotes should be provided. |
| |||||
Environment | String | Any simple single/multi-line text within quotes should be provided. |
| |||||
Fix Version/s | An array of objects | IssueLink Version object |
| Original Estimate | String | A Number of seconds or a duration string
| ||
Issue Type | Object | Issue Type object |
| |||||
Labels | Array of values | Value within quotes should be provided. |
| |||||
Priority | Object | Priority Linked Issues | An array of objects | IssueLink object | Security level | Object | Security level object |
|
Remaining Estimate | String | A Number of seconds or a duration string within quotes should be provided. |
| |||||
Reporter | Object | User object |
| |||||
Resolution | Object | Resolution Object |
| |||||
| Summary | String | Any simple single-line text
| |||||
Original Estimate | String | A Number of seconds or a duration string within quotes should be provided. |
| |||||
Time TrackingParent | Object | Object with original and remaining estimates should be provided. Note: This requires checking the "Treat value as JSON" option. |
| Watchers | An array of objects | User object | [ The value should be a valid issue object, containing at least a key or id field. Examples of Nunjucks expressions returning an issue object:
|
|
Priority | Object | Priority object |
| |||||
Remaining Estimate | String | A Number of seconds or a duration string within quotes should be provided. |
| |||||
Reporter | Object | User object |
| |||||
Resolution | Object | Resolution Object |
|
Predefined Custom fields
| |||
Security level | Object | Security level object |
|
Summary | String | Any simple single-line text within quotes should be provided. |
|
Time Tracking | Object | Object with original and remaining estimates should be provided. Note: This requires checking the "Treat value as JSON" option. |
|
Watchers | An array of objects | User object |
|
|
|
"1064X780"
to set the JIRA Capture for screen resolution field
- "
ghx-label-6"
Issue KEY of an Epic should be provided within quotes.
"TEST-300"
"TP-33"
"Creation of a new issue"
{"value":"Done"}
An array of objects
Options object
[{"value":"Impediment"}]
An array of values
An array of organization IDs or Organization names.
To obtain an Organization ID, navigate to the Organization and look at the end of the page URL in the navigation bar to find the ID, as shown below:
[1]
[1,33]
[Org 1, Org 2]
[Org 1, 4]
Session ID should be provided within quotes. The session ID can be obtained from the URL when you view the session.
"10011"
[{"
accountId
":"
"}]accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e
[{"
accountId
":"
"},{"accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e
accountId
":"
"}]accountId:557345:3a41d4ee-3331-4363-8edf-f90a2da92f7e
String containing an ISO_8601 date within quotes should be provided.
"2016-08-05"
Sprint ID should be provided within quotes.
To identify the Sprint ID, add the Sprint to an issue and use the Nunjucks Script tester with the following template: {{issue.fields["Sprint"] }}
and look at the id field in the result.
"3"
Number should be provided.
3
Team
Team ID should be provided within quotes. The team ID can be obtained from the URL when you view the tempo team.
"3"
"1"
(for the default team)
Team ID should be provided within quotes.
To identify the team ID, add the Team to an issue and use the Nunjucks Script tester with the following template: {{ issue.fields.Team }}
Note | ||
---|---|---|
| ||
You cannot clear this field, nor set it if it already has a value. This is due to JIRA Portfolio bugs. |
"3"
"1"
User-created custom fields
The value expected by custom fields depend on the Custom Field Type:
|
Predefined Custom fields
Field Name | Expected input type | Expected input value | Examples | |||||
---|---|---|---|---|---|---|---|---|
Account | String | Account ID or name |
| |||||
Approvers | An array of objects | User object |
| |||||
All Capture for JIRA fields | String | Any simple single-line text within quotes should be provided. |
| |||||
Epic Color | String | Any simple single-line text within quotes should be provided. |
| |||||
Epic link | String | Issue KEY of an Epic should be provided within quotes. |
| |||||
Epic Name | String | Any simple single/multi-line text within quotes should be provided. |
| |||||
Epic Status | String | Status value should be provided |
| |||||
Flagged | An array of objects | Options object |
| |||||
Organizations | An array of values | An array of organization IDs or Organization names. To obtain an Organization ID, navigate to the Organization and look at the end of the page URL in the navigation bar to find the ID, as shown below: |
| |||||
Raised during | String | Session ID should be provided within quotes. The session ID can be obtained from the URL when you view the session. |
| |||||
Request Participants | An array of objects | User object |
| |||||
Satisfaction Date | String | String containing an ISO_8601 date within quotes should be provided. |
| |||||
Sprint | String | Sprint ID should be provided within quotes. To identify the Sprint ID, add the Sprint to an issue and use the Nunjucks Script tester with the following template: |
| |||||
Story points | Number | Number should be provided. |
| |||||
Team | String | Team ID should be provided within quotes. The team ID can be obtained from the URL when you view the tempo team. |
| |||||
Team (Portfolio) | String | Team ID should be provided within quotes. To identify the team ID, add the Team to an issue and use the Nunjucks Script tester with the following template:
|
|
User-created custom fields
The value expected by custom fields depend on the Custom Field Type:
Custom field type | Expected input type | Expected input value | Examples | |||
---|---|---|---|---|---|---|
Check boxes/Select list (multiple) | An array of objects | Options object, each containing at least a To obtain an option ID, you can go to the custom field configuration, navigate to the Option, edit it and look at the end of the page URL in the navigation bar to find the ID. |
| |||
Radio buttons/Select list(single) | Object | Option object, with the To obtain an option ID, you can go to the custom field configuration, navigate to the Option, edit it and look at the end of the page URL in the navigation bar to | find the ID.[{"value":"Option A"}] find the ID. |
| ||
Radio buttons/Select list(single) | Object | Option objectcascading) | Object | Parent Object with the Parent Object - Child Object, with the To obtain an option the parent or child ID, you can go to the custom field configuration, navigate to the Optionparent or child, edit it and look at the end of the page URL in the navigation bar to find the ID. | User picker (Multi-users
| |
Select list(cascading) | Object | Parent Object with the Parent Object - Child Object, with the To obtain the parent or child ID, you can go to the custom field configuration, navigate to the parent or child, edit it and look at the end of the page URL in the navigation bar to find the ID. |
| |||
Single Group Picker | Object | Group object |
| |||
Multi Group Picker | An array of objects | Groups object |
| |||
Project Picker (single project) | Object | Project object |
| |||
User picker (Single user) | Object | User object |
| |||
| ||||||
Single Group Picker | Object | Group object |
| |||
Multi Group Picker | An array of objects | Groups object |
| |||
Project Picker (single project) | Object | Project object |
| |||
User picker (Single user) | Object | User object |
| |||
User picker (Multi-users) | An array of objects | User object |
| |||
Version Picker (single version) | Object | Version object |
| |||
Version Picker (multiple versions) | An array of objects | User Version object | Text Field (single line) | String | Any simple single line text
| |
Version Picker (single version) | Object | Version object |
| |||
Version Picker (multiple versions) | An array of objects | Version object |
| |||
Text Field (multi line) | String | Any simple single/multi-line text within quotes should be provided. |
| |||
| ||||||
Text Field (multi line) | String | Any simple single/multi-line text within quotes should be provided. |
| |||
Text Field (single line) | String | Any simple single line text within quotes should be provided. |
| |||
Text Field (read only) | String | Any simple single/multi-line text within quotes should be provided. |
| |||
URL Field | String | Any simple single text within quotes representing a URL should be provided. | ||||
Number Field | Number | Number should be provided |
| |||
Labels | An array of values | Value within quotes should be provided. |
| |||
Date picker | String | String containing an ISO_8601 date within quotes should be provided. |
| This is a regression test"Text Field (read only) | String | Any simple single/multi-line text
|
Date Time Picker | String | String containing an ISO_8601 date/time within quotes should be provided. |
| This is a regression test"|||
URL Field | String | Any simple single text within quotes representing a URL should be provided. | ||||
Number Field | Number | Number should be provided |
| |||
Labels | An array of values | Value within quotes should be provided. |
| |||
Date picker | String | String containing an ISO_8601 date within quotes should be provided. |
| |||
Date Time Picker | String | String containing an ISO_8601 date/time within quotes should be provided. |
| |||
Insight Objects | An array of Insight Objects | The value should be an array of Insight Objects. To obtain an Insight Object, you need to evaluate the following expression in the Nunjucks tester against an issue that has that Asset in the Insight Objects field:{{ issue.fields["Insight Objects"][0] | dump(2) }} | For a single object: For multiple objects: |