Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 Field NameExpected input typeExpected input valueExample
Affects Version/sAn array of objectsVersion object
  • [{"name":"2.0"}]
  • [{"name":"2.0"},{"name":"1.0"}]
  • {{issue.fields.fixVersions | dump}} - Using Nunjucks annotations to copy the Fix Versions
AssigneeObjectUser object, or null for Unassigned
  • {"nameaccountId":"accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e"}
  • {{issue.fields.reporter | dump}} - Using
    Nunjucks annotations to copy the Reporter
  • null
AttachmentsAn array of objectsAttachment object
Component/sAn array of objectsComponent object
  • [{"name":"C1"}]
  • [{"name":"C1"},{"name":"C2"}]
DescriptionStringAny simple single/multi-line text within quotes should be provided.
  • "This is a description"
Due dateStringString containing an ISO_8601 date within quotes should be provided.
  • "2016-08-09"
EnvironmentStringAny simple single/multi-line text within quotes should be provided.
  • "This is the QA Environment"
Fix Version/sAn array of objectsVersion object
  • [{"name":"2.0"}]
  • [{"name":"2.0"},{"name":"1.0"}]
Issue TypeObjectIssue Type object
  • {"name":"Bug"}
LabelsArray of valuesValue within quotes should be provided.
  • ["Label"]
  • ["a","b"]
Linked IssuesAn array of objectsIssueLink object
  • {{issue | epic | field("fields.issuelinks") | dump}} - Using Nunjucks annotations to copy the Linked issues of the current issue's Epic.
  • [{
      "type": {"name":"Blocks"},
      "outwardIssue": {"key":"TEST-1"}
    },
    {
      "type": {"name":"Blocks"},
      "inwardIssue": {"key":"TEST-2"}
    }]
Original EstimateString

A Number of seconds or a duration string within quotes should be provided.

  • "3w"
  • "2w 1d 6h"
  • "25200"
PriorityObjectPriority object
  • {"name":"High"}
Remaining EstimateString

A Number of seconds or a duration string within quotes should be provided.

  • "3w"
  • "2w 1d 6h"
  • "25200"
ReporterObjectUser object
  • {"nameaccountId":"accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e"}
ResolutionObjectResolution Object
  • {"name":"Duplicate"}
Security levelObjectSecurity level object
  • {"name":"QA Domain"}
SummaryStringAny simple single-line text within quotes should be provided.
  • "This is the Summary"
Time TrackingObjectObject with original and remaining estimates should be provided. Note: This requires checking the "Treat value as JSON" option.
  • {
      "originalEstimate": "5w",
      "remainingEstimate": "4w 1d"
    }
  • {
      "originalEstimate": "5w 2h 6h",
      "remainingEstimate": "25200"
    }
WatchersAn array of objectsUser object
  • [{"nameaccountId":"accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e"}]
  • [{"nameaccountId":"accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e"},{"nameaccountId":"accountId:557045:3a41d4ee-3331-4363-8cdf-f90a2da94fr3"}]

...

Field NameExpected input typeExpected input valueExamples
AccountString

Account ID or name

  • 2
  • "NewYork Account"
ApproversAn array of objectsUser object
  • [{"nameaccountId":"accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e"}]
  • [{"nameaccountId":"accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e"},{"nameaccountId":"accountId:557124:3a41d4ee-3331-4363-8cdf-f90a2da92r46"}]
All Capture for JIRA fieldsStringAny simple single-line text within quotes should be provided.
  • "1064X780" to set the JIRA Capture for screen resolution field
Epic ColorStringAny simple single-line text within quotes should be provided.
  • "ghx-label-6"
Epic linkString

Issue KEY of an Epic should be provided within quotes.

  • "TEST-300"
  • "TP-33"
Epic NameStringAny simple single/multi-line text within quotes should be provided.
  • "Creation of a new issue"
Epic StatusStringStatus value should be provided
  • {"value":"Done"}
Flagged

An array of objects

Options object

  • [{"value":"Impediment"}]
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: 

Eg: https://test.atlassian.net/projects/PSDF/organization/1


  • [1]
  • [1,33]
  • [Org 1, Org 2]
  • [Org 1, 4]


Raised duringString

Session ID should be provided within quotes. The session ID can be obtained from the URL when you view the session.

  • "10011"
Request ParticipantsAn array of objectsUser object
  • [{"nameaccountId":"accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e"}]
  • [{"nameaccountId":"accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e"},{"nameaccountId":"accountId:557345:3a41d4ee-3331-4363-8edf-f90a2da92f7e"}]
Satisfaction DateString

String containing an ISO_8601 date within quotes should be provided.

  • "2016-08-05"
SprintString

Sprint ID should be provided within quotes.

(info) 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"
Story pointsNumber

Number should be provided.

  • 3

Team

String

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 (Portfolio)String

Team ID should be provided within quotes. 

(info) 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
titleLimitations when setting this field

You cannot clear this field, nor set it if it already has a value. This is due to JIRA Portfolio bugs.


  • "3"
  • "1"

...

Custom field typeExpected input typeExpected input valueExamples
Check boxes/Select list (multiple)An array of objects

Options object, each containing at least a value or id field. 

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"}]
  • [{"value":"Option 1"},{"value":"Option 2"}]
  • [{"id":"10101"},{"id":"20102"}]
Radio buttons/Select list(single)Object

Option object, with the value or id field. 

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":"A"}
  • {
        "value": "A",
        "id": "10500"
    }
Select list(cascading)Object

Parent Object with the value or id field. 

Parent Object - Child Object, with the value or id field. 

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.

  • {"value":"parent", "child":{"value":"child"}}
  • {"id":"11111", "child":{"id":"22222"}}
  • {"value":"parent"}
Single Group PickerObjectGroup object
  • {"name":"Group1"}
Multi Group PickerAn array of objectsGroups object
  • [{"name":"Group1"}]
  • [{"name":"Group1"},{"name":"Group2"}]
Project Picker (single project)Object

Project object

  • {"key":"TEST"}
User picker (Single user)ObjectUser object
  • {"nameaccountId":"accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e"}
User picker (Multi-users)An array of objectsUser object
  • [{"nameaccountId":"accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e"}]
  • [{"nameaccountId":"accountId:557058:3a41d4ee-3331-4363-8cdf-f90a2da92f7e"},{"nameaccountId":"accountId:557124:3a41d4ee-3331-4363-8cdf-f90a2da92t4e"}]
Version Picker (single version)
ObjectVersion object
  • {"name":"2.0"}
Version Picker (multiple versions)An array of objectsVersion object
  • [{"name":"2.0"}]
  • [{"name":"2.0"},{"name":"1.0"}]
Text Field (multi line)StringAny simple single/multi-line text within quotes should be provided.
  • "This is a regression test\nResults are saved"
Text Field (single line)StringAny simple single line text within quotes should be provided.
  • "This is a regression test"
Text Field (read only)StringAny simple single/multi-line text within quotes should be provided.
  • "This is a regression test"
URL FieldStringAny simple single text within quotes representing a URL should be provided.
Number FieldNumberNumber should be provided
  • 30
LabelsAn array of valuesValue within quotes should be provided.
  • ["Label"]
  • ["a","b"]
Date pickerStringString containing an ISO_8601 date within quotes should be provided.
  • "2017-02-15"
Date Time PickerString

String containing an ISO_8601 date/time within quotes should be provided.

  • "2017-02-21T10:20:00.000+0100"

...