Our new Appfire Documentation Space is now live!

Take a look here! If you have any questions please email support@appfire.com

Standard JIRA fields

This page explains how to access the value of Standard Jira fields using Nunjucks. Each field's structure is explained with examples. To understand how to write values into these fields see, Text input for fields and JSON input for fields.

It is now possible to access the standard fields of an issue by its Field name or Key.

Example:

{{ issue.fields.watches.watchCount }} and {{ issue.fields.Watchers.watchCount }}, both return the number of watchers.

When the field name contains a space or any special character, you need to use the array syntax to access the field :

Example:

{{ issue.fields['Issue Type'].name }}

{{ issue.fields['Component/s'][0].name }}


In this page:

Affects Version/s

  • Field name : Affects Version/s

  • Key: versions

  • Description : The Affects Version/s field is an array of objects. Each object represents a single version.

  • Structure :

     Click here to see the structure of Affect Version/s
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		....
    		....
    		"versions": 
    		[
    			{
    				"self":String, //URL of the versions
    				"id":String, //ID of the version
    				"description": String, //Description of the version
    				"name":String, //Name of the version
    				"archived":Boolean, //True when archived
    				"released":Boolean, //True when released
    				"releaseDate":String //Release date of the version
    			},
    			{
    				//Second version and so on.
    			}
    			...
    		],
    		...
    	}
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		....
    		....
    		"versions": 
    		[
    			{
    				"self":"https://jmwe-test-2.atlassian.net/rest/api/2/version/10601",
    				"id":"10601",
    				"description":"Trial Version",
    				"name":"2",
    				"archived":false,
    				"released":true,
    				"releaseDate":"2016-10-06"
    			},
    			{
    					...
    			}
    		...
    		],
    	}
    }
  • Accessing the Affects version/s field

    • First Affects Version name : {{issue.fields.versions[0].name}}
    • Last Affects Version name:

      {{ issue.fields.versions | last | field("name")}}

      where '|' is the pipe operator, 'last' and 'field' are filters. See Nunjucks annotations for more filters.

    • Join the names of the Affects Version/s, separated by commas: {{issue.fields.versions | join("," , "name")}}

    • Return all the Affects Version/s, in a format that can be used to set the Fix Version/s field : {{issue.fields.versions | dump(2)}}

    • Test whether "1.0" is in the Affects Version/s: {{ issue.fields.versions | find({name:"1.0"}) }}

Assignee

  • Field name : Assignee

  • Key: assignee

  • Description : The Assignee field is an object that represents the user who this issue is assigned to.

  • Structure :

     Click here to see the structure of Assignee field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		....
    		....
    		"assignee": 
    		{
    			"self":String, //URL of the user
    			"accountId": String,
    			"emailAddress":String, //Email ID of the user
    			"avatarUrls": //URLs of assignee avatar
    			{
    				"48x48":String,
    				"24x24":String,
    				"16x16":String,
    				"32x32":String,
    			},
    			"displayName":String, //Display name of the user
    			"active":Boolean, //True when the user is active
    			"timeZone":String, //Time zone of the user
    			"accountType": String //Account type 
    		},
    	}
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		....
    		....
    		"assignee":
    		{
    			"self": "https://validationenvironment.atlassian.net/rest/api/2/user?accountId=5ca5b1469a000c1180956957",
    			"accountId": "accountId:5ca5b1469a000c1180956957",
    			"emailAddress":"rvijji@innovalog.com",
    			"avatarUrls":
    			{
    				"48x48":"https://jmwe-test-2.atlassian.net/secure/useravatar?avatarId=10337",
    				"24x24":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=small&avatarId=10337",
    				"16x16":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=xsmall&avatarId=10337",
    				"32x32":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=medium&avatarId=10337"
    			},
    			"displayName":"Radhika Vijji",
    			"active":true,
    			"timeZone":"Europe/Berlin",
    			"accountType": "atlassian"
    		},
    	}
    }
  • Accessing the Assignee field
    • AccountId of the Assignee : {{issue.fields.assignee.accountId}}
    • Timezone of the assignee : {{issue.fields.assignee.timeZone}}

Attachments

  • Field name : Attachment

  • Key: attachment

  • Description : Attachment is an array of objects. Each object represents a single attachment.

  • Structure :

     Click here to see the structure of Attachments
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		....
    		....
    		"attachment": 
            [
                {
                    "self":String, //URL of the attachment
                    "id":String, //ID of the attachment
                    "filename":String, //Name of the attachment
                    "author": //Author of the attachment
                    {
    		            "self":String, //URL of the author
    					"accountId": String,
         				"emailAddress":String, //Email ID of the author
          				"avatarUrls":
    				     {
               				"48x48":String, //URL of the author
                			"24x24":String, //URL of the author
                			"16x16":String, //URL of the author
                			"32x32":String, //URL of the author
            			},
            			"displayName":String, //Display name of the author
            			"active":Boolean, //True when the author is active
            			"timeZone":String, //Time zone of the author
    					"accountType": String //Account type 
                    },
                    "created":String, //Attachment created timestamp
                    "size":Number, //Size of the attachment
                    "mimeType":String, //Type of the attachment
                    "content":String, //Content of the attachment
                    "thumbnail":String //Thumbnail of the attachment
                },
            ],
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		....
    		....
    		"attachment":
    		[
    			{
    				"self":"https://jmwe-test-2.atlassian.net/rest/api/2/attachment/11001","id":"11001",
    				"filename":"one.png",
    				"author":
    				{
    					"self": "https://validationenvironment.atlassian.net/rest/api/2/user?accountId=5ca5b1469a000c1180956957",
    					"accountId": String,
    					"emailAddress":"rvijji@innovalog.com",
    					"avatarUrls":
    					{
    						"48x48":"https://jmwe-test-2.atlassian.net/secure/useravatar?avatarId=10337",
    						"24x24":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=small&avatarId=10337",
    						"16x16":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=xsmall&avatarId=10337",
    						"32x32":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=medium&avatarId=10337"
    					},
    					"displayName":"Radhika Vijji",
    					"active":true,
    					"timeZone":"Europe/Berlin",
    					"accountType": String //Account type 
    					
    				},
    				"created":"2016-10-13T12:33:50.472+0200",
    				"size":31721,
    				"mimeType":"image/png",
    				"content":"https://jmwe-test-2.atlassian.net/secure/attachment/11001/one.png",
    				"thumbnail":"https://jmwe-test-2.atlassian.net/secure/thumbnail/11001/_thumb_11001.png"
    			}
    			{
    				//Second attachment and so on..
    				}
    		],
    		...
    	}
    	...
    }
  • Accessing the Attachment field

    • Size of the last attachment :

      {{ issue.fields.attachment | last | field("size")%}

      where '|' is the pipe operator, 'last' and 'field' are filters. See Nunjucks annotations for more filters.

    • Name of the Author of the first attachment : {{ issue.fields.attachment[0].author.accountId}}

Created

  • Field name : Created

  • Key: created

  • Description : The Created field is a string representation of a date.

  • Structure :

     Click here to see the structure of the Created field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"created":String, //Created datetime stamp
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"created":"2016-10-13T08:10:16.644+0200",
    		...	
    	}
    	...
    }
  • Accessing the Created fields
    • Created date of the issue : {{ issue.fields.created }}

    • Format the created date : {{ issue.fields.created | date('fromNow') }}

You can use the date filter to manipulate and/or format the value

Creator

  • Field name : Creator

  • Key: creator

  • Description : The Creator field is an object that represents the user who created this issue.

  • Structure :

     Click here to see the structure of Creator field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		....
    		....
    		"assignee": 
    		{
    			"self":String, //URL of the user
    			"accountId": String,
    			"emailAddress":String, //Email ID of the user
    			"avatarUrls": //URLs of assignee avatar
    			{
    				"48x48":String,
    				"24x24":String,
    				"16x16":String,
    				"32x32":String,
    			},
    			"displayName":String, //Display name of the user
    			"active":Boolean, //True when the user is active
    			"timeZone":String, //Time zone of the user
    			"accountType": String
    		},
    	}
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		....
    		....
    		"assignee":
    		{
    			"self":"https://jmwe-test-2.atlassian.net/rest/api/2/user?username=rvijji",
    			"accountId": "accountId:5ca5b1469a000c1180956957",
    			"emailAddress":"rvijji@innovalog.com",
    			"avatarUrls":
    			{
    				"48x48":"https://jmwe-test-2.atlassian.net/secure/useravatar?avatarId=10337",
    				"24x24":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=small&avatarId=10337",
    				"16x16":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=xsmall&avatarId=10337",
    				"32x32":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=medium&avatarId=10337"
    			},
    			"displayName":"Radhika Vijji",
    			"active":true,
    			"timeZone":"Europe/Berlin",
    			"accountType": "atlassian"
    		},
    	}
    }
  • Accessing the Creator field
    • Name of the Creator of the issue : {{ issue.fields.creator.accountId }}

    • Display name of the creator : {{ issue.fields.creator.displayName }}

Comments

  • Field name : Comment

  • Key: comment

  • Description : The Comments field is an object with two fields:

    • comments, containing an array of objects. Each object represents a single comment.

    • total, showing the number of comments
  • Structure :

     Click here to see the structure of Comments
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		....
    		....
    		"comment":
    		{
    			"comments":
    			[
    				{
    					"self":String, //URL of the first comment
                        "id":String, //ID of the first comment
                        "author": //The "Author" field is an object with the following fields
    					{
    						"self":String, //URL of the author
           					"accountId": String,
         				   	"emailAddress":String, //Email ID of the author
          				  	"avatarUrls":
    				        {
               					"48x48":String, //URL of the author
                				"24x24":String, //URL of the author
                				"16x16":String, //URL of the author
                				"32x32":String, //URL of the author
            				},
            				"displayName":String, //Display name of the author
            				"active":Boolean, //True when the author is active
            				"timeZone":String, //Time zone of the author
    						"accountType": String //Account type
    					},
    					"body":"1",
    					"updateAuthor":
    					{
    						"self":String, //URL of the update author
           					"accountId": String, //AccountId of the author
         				   	"emailAddress":String, //Email ID of the update author
          				  	"avatarUrls":
    				        {
               					"48x48":String, //URL of the update author
                				"24x24":String, //URL of the update author
                				"16x16":String, //URL of the update author
                				"32x32":String, //URL of the update author
            				},
            				"displayName":String, //Display name of the update author
            				"active":Boolean, //True when the update authoris active
            				"timeZone":String, //Time zone of the update author
    						"accountType": String //Account type						
    					},
    					"created":String, //Time stamp when the comment is created
                        "updated":String, //Time stamp when the comment is updated
    				},
    				{
    					//Second comment and so on..
    				}
    			],
    			 "maxResults":Number, //Total number of comments
                "total":Number, //Total number of comments
                "startAt":Number //Number at which the comments started.
    		},
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		....
    		....
    		"comment":
    		{
    			"comments":
    			[
    				{
    					"self":"https://jmwe-test-2.atlassian.net/rest/api/2/issue/30102/comment/27600",
    					"id":"27600",
    					"author":
    					{
    						"self": "https://validationenvironment.atlassian.net/rest/api/2/user?accountId=5ca5b1469a000c1180956957",
    						"accountId": "accountId:5ca5b1469a000c1180956957",
    						"emailAddress":"rvijji@innovalog.com",
    						"avatarUrls":
    						{
    							"48x48":"https://jmwe-test-2.atlassian.net/secure/useravatar?avatarId=10337",
    							"24x24":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=small&avatarId=10337",
    							"16x16":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=xsmall&avatarId=10337",
    							"32x32":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=medium&avatarId=10337"
    						},
    						"displayName":"Radhika Vijji",
    						"active":true,
    						"timeZone":"Europe/Berlin",
    						"accountType": "atlassian"
    					},
    					"body":"1",
    					"updateAuthor":
    					{
    						"self": "https://validationenvironment.atlassian.net/rest/api/2/user?accountId=5ca5b1469a000c1180956957",
    						"accountId": "accountId:5ca5b1469a000c1180956957",
    						"emailAddress":"rvijji@innovalog.com",
    						"avatarUrls":
    						{
    							"48x48":"https://jmwe-test-2.atlassian.net/secure/useravatar?avatarId=10337",
    							"24x24":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=small&avatarId=10337",
    							"16x16":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=xsmall&avatarId=10337",
    							"32x32":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=medium&avatarId=10337"
    						},
    						"displayName":"Radhika Vijji",
    						"active":true,
    						"timeZone":"Europe/Berlin",
    						"accountType": "atlassian"
    					},
    					"created":"2016-10-13T12:02:41.802+0200",
    					"updated":"2016-10-13T12:02:41.802+0200"
    				},
    				{
    					//Second comment and so on..
    				}
    			],
    			"maxResults":2,
    			"total":2,
    			"startAt":0
    		},
    		...
    	}
    	...
    }
  • Accessing the Comments field

    • Number of comments on the issue : {{issue.fields.comment.total}}
    • Last Comment body :

      {{ issue.fields.comment.comments | last | field("body") }}

      where '|' is the pipe operator, 'last' and 'field' are filters. See Nunjucks annotations for more filters.

    • AccountId of the author of the first comment on the issue :

      {{ issue.fields.comment.comments | first | field("author.accountId") }}

      where '|' is the pipe operator, 'first' and 'field' are filters. See Nunjucks annotations for more filters.

    • Email address of the author of the last comment on the issue :

      {{ issue.fields.comment.comments | last | field("author.emailAddress") }}

      where '|' is the pipe operator, 'last' and 'field' are filters. See Nunjucks annotations for more filters.

    • Display all the comments in a text field : {{ issue.fields.comment.comments | join("\n" , "body") }}

Component/s

  • Field name : Component/s

  • Key: components

  • Description : The Components field is an array of objects. Each object represents one component.

  • Structure :

     Click here to see the structure of Components field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		....
    		....
    		"components":
    		[
    			{
    				"self": String, //URL of the component
    				"id":String, //ID of the component
    				"name": String, //Name of the component
    				"description":String //Description of the component
    			},
    			{
    				//Second component and so on..
    			}
    		]
    	}
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		....
    		....
    		"components":
    		[
    			{
    				"self":"https://jmwe-test-2.atlassian.net/rest/api/2/component/10500",
    				"id":"10500",
    				"name":"C1",
    				"description":"C1 set"
    			},
    			{
    				//Second component and so on..
    			}
    		]
    	}
    }
  • Accessing the Components field
    • First component name : {{issue.fields.components[0].name}}

    • Last component description :

      {{ issue.fields.components | last | field("description") }}

      where '|' is the pipe operator, 'last' and 'field' are filters. See Nunjucks annotations for more filters.

    • All components of the current issue:

      {{issue.fields.components | join ("," , "name") }}
    • Test whether "UI" is in the Components: {{ issue.fields.components | find({name:"UI"}) }}

Description

  • Field name : Description

  • Key: description

  • Description : The Description field is a string representation of a multi-line text describing the issue.

  • Structure :

     Click here to see the structure of Description field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"description": String, //Description of the issue
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"description": "New test",
    		...
    	}
    	...
    }
  • Accessing the Description field
    • Description of the issue : {{issue.fields.description}}

Due Date

  • Field name : Due Date

  • Key: duedate

  • Description : The Due Date field is a string representation of a date.

  • Structure :

     Click here to see the structure of Due date field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"duedate": String, //Due date of the issue
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"duedate": "2016-08-09",
    		...
    	}
    	...
    }
  • Accessing the Due date field
    • The Due date of the issue : {{issue.fields.duedate}}

    • Set the Due date to Created + 2 days if the priority of the issue is "Highest". Ignore it, if it is already less than or equal to 2 days (using the "Ignore empty value" option) :

      {% set duedate = issue.fields.duedate %}
      {% set newdate = issue.fields.created | dateadd(2,"d") %}
      {% if issue.fields.priority.name == "Highest" %}
      	{% if duedate >= newdate or duedate == null%}
      		{{newdate}}
      	{%else%}
      		{{duedate}}
      	{%endif%}
      {%endif%}
    • Format the due date and add it as a comment on the issue, once the issue is transitioned to In Progress state :

      This issue is due on : {{ issue.fields.duedate | date('dddd, MMMM Do YYYY, h:mm:ss a') }}

      where, date is the date filter. See Nunjucks annotations for more filters.

You can use the date filter to manipulate and/or format the value

Environment

  • Field name : Environment

  • Key: environment

  • Description : The Environment field is a string representation of a multi-line text describing the environment of the issue.

  • Structure :

     Click here to see the structure of Environment field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"environment": String, //Environment of the issue
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"environment":null,
    		...
    	}
    	...
    }
  • Accessing the Environment field
    • The Environment of the issue : {{issue.fields.environment}}

FixVersion/s

  • Field name : Fix Version/s

  • Key: fixVersions

  • Description : The Fix Version/s field is an array of objects. Each object represents a single version.

  • Structure :

     Click here to see the structure of Fix Version/s
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"fixVersions": 
    		[
    			{
    				"self":String, //URL of the versions
    				"id":String, //ID of the version
    				"description": String, //Description of the version
    				"name":String, //Name of the version
    				"archived":Boolean, //True when archived
    				"released":Boolean, //True when released
    				"releaseDate":String //Release date of the version
    			}
    			{
    				//Second version and so on.
    			}
    			...
    		],
    		...	
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		....
    		....
    		"fixVersions":
    		[
    			{
    				"self":"https://jmwe-test-2.atlassian.net/rest/api/2/version/10706",
    				"id":"10706",
    				"name":"2.0",
    				"archived":false,
    				"released":true,
    				"releaseDate":"2016-10-06"
    			}
    			{
    				Second fix version and so on..
    			}
    		],
    		...
    	}
    	...
    }
  • Accessing the Fix Version/s field
    • First Fix Version/s name : {{issue.fields.fixVersions[0].name}}

    • Last Fix Version/s name:

      {{ issue.fields.fixVersions | last | field("name") }}

      where '|' is the pipe operator, 'first' and 'field' are filters. See Nunjucks annotations for more filters.

    • Return only Fix Versions that are not released, separated by commas:

      {% set versions = issue.fields.fixVersions %}
      {% set comma = joiner() %}
      {% for version in versions -%}
      	{% if not version.released %}
      		{{ comma() }}{{ version.name }}
      	{%endif%}
      {%- endfor %}

      The joiner function is a global Nunjucks function describe here.

    • Join the names of the Fix Version/s, separated by commas : {{issue.fields.fixVersions | join("," , "name")}}

    • Test whether "1.0" is in the Fix Version/s: {{ issue.fields.fixVersions | find({name:"1.0"}) }}

  • Field name : Linked Issues

  • Key: issuelinks

  • Description : Issue links is an array of objects. Each object represents one link.

  • Structure :

     Click here to see the structure of Issue links
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"issuelinks": 
            [
                {
                    "id": String, //ID of the issue
                    "self": String, //URL of the issue
                    "type": [object] //Type of the issue link.
                    {
                        "id": String, //Id of the issue link
                        "name": String, //Name of the issue link
                        "inward": String, //Inward description of the link
                        "outward": String, //Outward description of the link
                        "self": String //URL of the issueLinkType
                    },
                    "outwardIssue": [object] //Outward issue information.
                    {
                        "id": String, //ID of the outward issue.
                        "key": String, //Key of the outward issue.
                        "self": String, //URL of the outward issue.
                        "fields": [object] //Fields of the outward issue.
                        {
                            "summary": String, //Summary of the outward issue.
                            "status": [object] //Status of the outward issue.
                            {
                                "self": String, //URL of the status of the outward issue.
                                "description": String, //URL of the status of the outward issue.
                                "iconUrl": String, //URL of the status icon of the outward issue.
                                "name": String, //Name of the status of the outward issue.
                                "id": String, //ID of the status of the outward issue.
                                "statusCategory": [object] //Status category
                                {
                                    "self": String, //URL of the status category
                                    "id": Number, //ID of the status category
                                    "key": String, //Key of the status category
                                    "colorName": String, //Colour of the status category
                                    "name": String //Name of the status
                                }
                            },
                            "priority": [object] //Priority of the outward issue.
                            {
                                "self":String, //URL of the priority of the issue
                                "iconUrl":String, //URL of the priority icon
                                "name":String, //Name of the priority
                                "id":String //ID of the priority
                            },
                            "issuetype": [object] //Issue type of the outward issue.
                            {
                                "self":String, //URL of the Issue type.
                                "id":String, //ID of the Issue type.
                                "description":String, //Description of the Issue type.
                                "iconUrl":String, //URL of the Issue type icon
                                "name":String, //Name of the Issue Type.
                                "subtask": "Boolean", //True when issue is a sub-task.
                                "avatarId": Number, //Number of the avatar ID of the issue.
                            }
                        }
                    },
                    "inwardIssue": [object] //Inward issue information.
                    {
                        "id": String, //ID of the outward issue.
                        "key": String, //Key of the outward issue.
                        "self": String, //URL of the outward issue.
                        "fields": [object] //Fields of the outward issue.
                        {
                            "summary": String, //Summary of the outward issue.
                            "status": [object] //Status of the outward issue.
                            {
                                "self": String, //URL of the status of the outward issue.
                                "description": String, //URL of the status of the outward issue.
                                "iconUrl": String, //URL of the status icon of the outward issue.
                                "name": String, //Name of the status of the outward issue.
                                "id": String, //ID of the status of the outward issue.
                                "statusCategory": [object] //Status category
                                {
                                    "self": String, //URL of the status category
                                    "id": Number, //ID of the status category
                                    "key": String, //Key of the status category
                                    "colorName": String, //Colour of the status category
                                    "name": String //Name of the status
                                }
                            },
                            "priority": [object] //Priority of the outward issue.
                            {
                                "self":String, //URL of the priority of the issue
                                "iconUrl":String, //URL of the priority icon
                                "name":String, //Name of the priority
                                "id":String //ID of the priority
                            },
                            "issuetype": [object] //Issue type of the outward issue.
                            {
                                "self":String, //URL of the Issue type.
                                "id":String, //ID of the Issue type.
                                "description":String, //Description of the Issue type.
                                "iconUrl":String, //URL of the Issue type icon
                                "name":String, //Name of the Issue Type.
                                "subtask": "Boolean", //True when issue is a sub-task.
                                "avatarId": Number, //Number of the avatar ID of the issue.
                            }
                        }
                    }
    
    
    
                },
                {
                    //Second Issue link and so on. 
                }
                ...
            ],
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"issuelinks":
    		[
    			{
    				"id":"13618",
    				"self":"https://jmwe-test-2.atlassian.net/rest/api/2/issueLink/13618",
    				"type":
    				{
    					"id":"10200",
    					"name":"Problem/Incident",
    					"inward":"is caused by",
    					"outward":"causes",
    					"self":"https://jmwe-test-2.atlassian.net/rest/api/2/issueLinkType/10200"
    				},
    				"inwardIssue":
    				{
    					"id":"30104",
    					"key":"TEST-631",
    					"self":"https://jmwe-test-2.atlassian.net/rest/api/2/issue/30104",
    					"fields":
    					{
    						"summary":"test",
    						"status":
    						{
    							"self":"https://jmwe-test-2.atlassian.net/rest/api/2/status/10000",
    							"description":"",
    							"iconUrl":"https://jmwe-test-2.atlassian.net/images/icons/status_generic.gif",
    							"name":"To Do",
    							"id":"10000",
    							"statusCategory":
    							{
    								"self":"https://jmwe-test-2.atlassian.net/rest/api/2/statuscategory/2",
    								"id":2,
    								"key":"new",
    								"colorName":"blue-gray",
    								"name":"To Do"
    							}
    						},
    						"priority":
    						{
    							"self":"https://jmwe-test-2.atlassian.net/rest/api/2/priority/3",
    							"iconUrl":"https://jmwe-test-2.atlassian.net/images/icons/priorities/medium.svg",
    							"name":"Medium",
    							"id":"3"
    						},
    						"issuetype":
    						{
    							"self":"https://jmwe-test-2.atlassian.net/rest/api/2/issuetype/10002",
    							"id":"10002",
    							"description":"A task that needs to be done.",
    							"iconUrl":"https://jmwe-test-2.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10318&avatarType=issuetype",
    							"name":"Task",
    							"subtask":false,
    							"avatarId":10318
    						}
    					}
    				}
    			}
    			{
    				//Second link and so on..
    			}
    		],
    		...
    	}
    	...
    }

    Note that only one of inwardIssue or outwardIssue will be present in each issue link. Also, note that only a small subset of the linked issues' fields will be present. A much easier way to access linked issues is through the use of the linkedIssues, epic, stories, parentIssue and subtasks filters.

Issue type

  • Field name : Issue Type

  • Key: issuetype

  • Description : The Issue Type field is an object describing the issue type.

  • Structure :

     Click here to see the structure of the Issue type field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"issuetype":
            {
                "self":String, //URL of the Issue type.
                "id":String, //ID of the Issue type.
                "description":String, //Description of the Issue type.
                "iconUrl":String, //URL of the Issue type icon
                "name":String, //Name of the Issue Type.
                "subtask": "Boolean", //True when issue is a sub-task.
                "avatarId": Number, //Number of the avatar ID of the issue.
            },
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"issuetype":
    		{
    			"self":"https://jmwe-test-2.atlassian.net/rest/api/2/issuetype/10001",
    			"id":"10001",
    			"description":"A user story. Created by Jira Software - do not edit or delete.",
    			"iconUrl":"https://jmwe-test-2.atlassian.net/images/icons/issuetypes/story.svg",
    			"name":"Story",
    			"subtask":false,
    			"avatarId":3.0
    		},
    		...
    	}
    	...
    }
  • Accessing the Issue type field
    • Name of the issue type : {{issue.fields.issuetype.name}}

    • Set a text field to "This issue is a sub-task" if the issue is a sub-task :

      {% if issue.fields.issuetype.subtask == true %}
      	This issue is a sub-task
      {% else %}
      	This issue is not a sub-task
      {% endif %}
      

Key

  • Key: key

  • Description : The Key of the issue is a string that represents the key of the issue.

  • Structure :

     Click here to see the structure of the Key
    Structure
    "issue":
    {
    	...
    	"key":String, //Key of the issue
    	"fields":
    	{
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	"key":"TEST-629",
    	"fields":
    	{
    		...
    	}
    	...
    }



  • Accessing the Key of the issue
    • Key of the issue : {{issue.key}}

Labels

  • Field name : Labels

  • Key: labels

  • Description : Labels is an array of values representing the labels of the issue.

  • Structure :

     Click here to see the structure of Labels field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"labels":
    		[
    			"
    			"Value1"
    			"Value2"
            	...
    		],
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"labels":
    		[
    			"Ready"
                "Cleared"
                ...
    		],
    		...
    	}
    	...
    }
  • Accessing the Labels field
    • First label : {{ issue.fields.labels[0] }}

    • Last label : {{ issue.fields.labels | last }}
    • All the labels of the issue separated by a space : {{issue.fields.labels | join(" ")}}

    • Test whether "myLabel" is in the labels: {{ issue.fields.labels | find("myLabel") }}

Last Viewed

  • Key: lastViewed

  • Description : Last Viewed field is a string representation of a date.

  • Structure :

     Click here to see the structure of LastViewed field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"lastViewed":String, //Last viewed time stamp
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		lastViewed":"2016-10-13T09:04:27.799+0200",
    		...
    	}
    	...
    }
  • Accessing the LastViewed field
    • Last viewed time stamp : {{issue.fields.lastViewed}}

You can use the date filter to manipulate and/or format the value.


You cannot use this field's value in 'Set field value' or 'Set field value of linked issues' post-functions because this field is special. Its value is user-specific. Since these post-functions are run as the add-on user the field value fetched will always be empty.

However, you can use this field in the 'Comment [linked] issue' post-functions, since it is run as the current user.

Original Estimate

  • Field name : Original Estimate

  • Key: timeoriginalestimate

  • Description : The Original Estimate field is a string representation of a number representing the original time estimate in seconds.

  • Structure :

     Click here to see the structure of Original Estimate field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"timeoriginalestimate": Number, //Original estimate in seconds
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"timeoriginalestimate": 144000,
    		...
    	}
    	...
    }
  • Accessing the Original Estimate field
    • Original Estimate of the issue in seconds : {{ issue.fields.timeoriginalestimate }}

    • You can access the Original estimate from the Standard JIRA fields#Time tracking field as well.

Parent

  • Field name : Parent

  • Key: parent

  • Description : The Parent field is an object representing the parent of the issue.

  • Structure :

     Click here to see the structure of Parent field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"parent":
    		{
    			"id":String, //Id of the parent issue
    			"key":String, //Key of the parent issue
    			"self":String, //URL of the parent issue
    			"fields":
    			{
    				"summary":String, //Summary of the parent issue
    				"status":
    				{
    					"self":String, //URL of the status
    					"iconUrl":String, //Icon URL of the status
    					"name":String, //Name of the status
    					"id":String, //Id of the status
    					"statusCategory":
    					{
    						"self":String, //Status category of the status
    						"id":String, //ID of the status category
    						"key":String, //Key of the status category
    						"colorName":String, //Color of the status category
    						"name":String, //Name of the status category
    					}
    				}
    		...
    	},
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"parent":
    		{
    			"id":"34701",
    			"key":"TEST-860",
    			"self":"https://jmwe-test-2.atlassian.net/rest/api/2/issue/34701",
    			"fields":
    			{
    				"summary":"Parent Issue",
    				"status":
    				{
    					"self":"https://jmwe-test-2.atlassian.net/rest/api/2/status/10000","description":"",
    					"iconUrl":"https://jmwe-test-2.atlassian.net/images/icons/status_generic.gif",
    					"name":"To Do",
    					"id":"10000",
    					"statusCategory":
    					{
    						"self":"https://jmwe-test-2.atlassian.net/rest/api/2/statuscategory/2",
    						"id":2,
    						"key":"new",
    						"colorName":"blue-gray",
    						"name":"To Do"
    					}
    				}
    		...
    		},
    	...
    	}
    ...
    }
  • Accessing the Parent field
    • Summary of the parent issue : {{ issue.fields.parent.fields.summary }}

    • Key of the parent issue : {{ issue.fields.parent.key }}
    • Id of the parent issue : {{ issue.fields.parent.id }}

Priority

  • Field name : Priority

  • Key: priority

  • Description : The Priority field is an object describing the priority of the issue.

  • Structure :

     Click here to see the structure of Priority field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"priority:
            {
                "self":String, //URL of the priority of the issue
                "iconUrl":String, //URL of the priority icon
                "name":String, //Name of the priority
                "id":String //ID of the priority
            },
    		...
    	},
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"priority":
    		{
    			"self":"https://jmwe-test-2.atlassian.net/rest/api/2/priority/3",
    			"iconUrl":"https://jmwe-test-2.atlassian.net/images/icons/priorities/medium.svg",
    			"name":"Medium",
    			"id":"3"
    		}
    		...
    	}
    	...
    }
  • Accessing the Priority field
    • Name of the Priority of the issue : {{ issue.fields.priority.name }}

    • ID of the Priority of the issue : {{ issue.fields.priority.id }}

Progress

  • Field name : Progress

  • Key: progress

  • Description : The Progress field is an object describing the progress on the issue.

  • Structure :

     Click here to see the structure of Progress field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"progress":
    		{
             	"progress":Number, //Progress of the issue in seconds
                "total":Number, //Total Progress of the issue in seconds
                "percent":Number //Percentage of progress of issue
            },
    		...
    	},
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"progress":
    		{
    			"progress":28800,
    			"total":57600,
    			"percent":50
    		},
    		...
    	}
    	...
    }
  • Accessing the Progress field
    • Progress on the issue in seconds : {{ issue.fields.progress.progress }}

    • Total progress on the issue in seconds : {{ issue.fields.progress.total }}
    • Percentage of progress on the issue : {{ issue.fields.progress.percent }}

Project

  • Field name : Project

  • Key: project

  • DescriptionThe Project field is an object describing the selected project.

  • Structure :

     Click here to see the structure of Project field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"project":
            {
                "self":String, //URL of the project.
                "id":String, //ID of the project.
                "key":String, //Key of the project.
                "name":String, //Name of the project.
                "avatarUrls": //URL of the project avatar
                {
                    "48x48":String, 
                    "24x24":String, 
                    "16x16":String,
                    "32x32":String,
                }
            },
    		...
    	},
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"project":
    		{
    			"self":"https://jmwe-test-2.atlassian.net/rest/api/2/project/10000",
    			"id":"10000",
    			"key":"TEST",
    			"name":"Test",
    			"avatarUrls":
    			{
    				"48x48":"https://jmwe-test-2.atlassian.net/secure/projectavatar?avatarId=10324",
    				"24x24":"https://jmwe-test-2.atlassian.net/secure/projectavatar?size=small&avatarId=10324",
    				"16x16":"https://jmwe-test-2.atlassian.net/secure/projectavatar?size=xsmall&avatarId=10324",
    				"32x32":"https://jmwe-test-2.atlassian.net/secure/projectavatar?size=medium&avatarId=10324"
    			}
    		}
    		...
    	}
    	...
    }
  • Accessing the Project field
    • Name of the project the issue belongs to : {{ issue.fields.project.name }}

    • Key of the project the issue belongs to : {{ issue.fields.project.key}}

Remaining Estimate

  • Field name : Remaining Estimate

  • Key: timeestimate

  • DescriptionThe Remaining Estimate field is a string representation of a number representing the remaining time estimate in seconds.

  • Structure :

     Click here to see the structure of Remaining Estimate field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"timeestimate": Number, //Remaining estimate in seconds
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"timeestimate": 144000,
    		...
    	}
    	...
    }
  • Accessing the Remaining Estimate field
    • Remaining Estimate of the issue in seconds : {{ issue.fields.timeestimate }}

    • You can access the Remaining estimate from the Standard JIRA fields#Time tracking field as well.

Reporter

  • Field name : Reporter

  • Key: reporter

  • DescriptionThe Reporter field is an object that represents the user by whom this issue is reported.

  • Structure :

     Click here to see the structure of Reporter field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"reporter":
    		{
    			"self":String, //URL of the user
    			"accountId": String,
            	"emailAddress":String, //Email ID of the user
            	"avatarUrls": //URLs of reporter avatar
            	{
                	"48x48":String,
                	"24x24":String,
                	"16x16":String,
                	"32x32":String,
           		},
            	"displayName":String, //Display name of the user
            	"active":Boolean, //True when the user is active
            	"timeZone":String, //Time zone of the user
    			"accountType": String //Account type 
    		},
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"reporter":
    		{
    			"self": "https://validationenvironment.atlassian.net/rest/api/2/user?accountId=5ca5b1469a000c1180956957",
    			"accountId": "accountId:5ca5b1469a000c1180956957",
    			"emailAddress":"rvijji@innovalog.com",
    			"avatarUrls":
    			{
    				"48x48":"https://jmwe-test-2.atlassian.net/secure/useravatar?avatarId=10337",
    				"24x24":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=small&avatarId=10337",
    				"16x16":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=xsmall&avatarId=10337",
    				"32x32":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=medium&avatarId=10337"
    			},
    			"displayName":"Radhika Vijji",
    			"active":true,
    			"timeZone":"Europe/Berlin",
    			"accountType": "atlassian"
    		},
    		...
    	}
    	...
    }
  • Accessing the Reporter field
    • AccountId of the reporter of the issue : {{ issue.fields.reporter.accountId}}

    • Email address of the reporter : {{ issue.fields.reporter.emailAddress }}

Resolution

  • Field name : Resolution

  • Key: resolution

  • Description : The Resolution field is an object describing the resolution of the issue.

  • Structure :

     Click here to see the structure of the Resolution field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"resolution":
            {
                "self": String, //URL of the resolution of the issue.
                "id": String, //ID of the resolution of the issue.
                "description": String, //Description of the resolution.
                "name": String //Name of the resolution of the issue.
      		},
    	...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"resolution":
    		{
    			"self":"https://jmwe-test-2.atlassian.net/rest/api/2/resolution/10000",
    			"id":"10000",
    			"description":"Work has been completed on this issue.",
    			"name":"Done"
    		},
    		...
    	}
    	...
    }
  • Accessing the Resolution field
    • Name of the Resolution of the issue : {{ issue.fields.resolution.name }}

    • Description of the resolution : {{ issue.fields.resolution.description }}

Resolved

  • Field name : Resolved

  • Key: resolutiondate

  • Description : The Resolved field is a string representation of a date.

  • Structure :

     Click here to see the structure of the Resolved field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"resolutiondate": String, //Resolved timestamp
    	...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"resolutiondate":"2016-10-13T11:15:46.789+0200",
    		...
    	}
    	...
    }
  • Accessing the Resolved field
    • Time stamp of resolution : {{ issue.fields.resolutiondate }}

You can use the date filter to manipulate and/or format the value

Security level

  • Field name : Security Level

  • Key: security

  • DescriptionThe Security level field is an object describing the security level of the issue.

  • Structure :

     Click here to see the structure of the Security Level field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"security":
    		{
    			"self": String, //URL of the security level
    			"id": String, //ID of the security level
    			"description": String, //Description of the security level
    			"name": String //Name of the security level
    		},
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"security":
    		{
    			"self":"https://jmwe-test-2.atlassian.net/rest/api/2/securitylevel/10000",
    			"id":"10000",
    			"description":"New security level for QA",
    			"name":"QA new security"
    		},
    		...
    	}
    	...
    }



  • Accessing the Security level field
    • Name of the security level of the issue : {{ issue.fields.security.name }}

    • Description of the security level of the issue : {{ issue.fields.security.description }}

Status

  • Field name : Status

  • Key: status

  • Description : The Status field is an object describing the status of the issue.

  • Structure :

     Click here to see the structure of the Status field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"status": 
            {
                "self":String, //Status of the issue
                "description":String, //Description of the status
                "iconUrl":String, //URL of the status icon
                "name":String, //Name of the status
                "id":String, //ID of the status
                "statusCategory":
                {
                    "self":String, //URL of the status category
                    "id":Number, //ID of the status category
                    "key":String, //Key of the status category
                    "colorName":String, //Colour of the status category
                    "name":String //Name of the status
                }
            },
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"status":
    		{
    			"self":"https://jmwe-test-2.atlassian.net/rest/api/2/status/10000",
    			"description":"",
    			"iconUrl":"https://jmwe-test-2.atlassian.net/images/icons/status_generic.gif",
    			"name":"To Do",
    			"id":"10000",
    			"statusCategory":
    			{
    				"self":"https://jmwe-test-2.atlassian.net/rest/api/2/statuscategory/2",
    				"id":2,
    				"key":"new",
    				"colorName":"blue-gray",
    				"name":"To Do"
    			}
    		}
    		...
    	}
    	...
    }



  • Accessing the Status field
    • Name of the status of the issue : {{ issue.fields.status.name }}

    • Name of the status category of the status : {{ issue.fields.status.statusCategory.name }}

Subtasks

  • Field name : Sub-tasks

  • Key: subtasks

  • Description : Sub-tasks is an array of objects. Each object represents a single sub-task.

  • Structure :

     Click here to see the structure of subtasks
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"subtasks": //The subtasks is an array of objects. Each subtask is an object in itself.
            [
                {
                    "id":String, //ID of the sub-task
                    "key":String, //Key of the sub-task
                    "self": String, //URL of the sub-task
                    "fields": [object] //Fields of the sub-task.
                    {
                        "summary":"child",
                        "status":
                        {
                            "self":String, //Status of the sub-task
                            "description":String, //Description of the status
                            "iconUrl":String, //URL of the status icon
                            "name":String, //Name of the status
                            "id":String, //ID of the status
                            "statusCategory":
                            {
                                "self":String, //URL of the status category
                                "id":Number, //ID of the status category
                                "key":String, //Key of the status category
                                "colorName":String, //Colour of the status category
                                "name":String //Name of the status
                            }
                        },
                        "priority":
                        {
                            "self":String, //URL of the priority of the sub-task
                            "iconUrl":String, //URL of the priority icon of the sub-task
                            "name":String, //Name of the priority of the sub-task
                            "id":String //ID of the priority of the sub-task
                        },
                        "issuetype":
                        {
                            "self":String, //URL of the sub-task's Issue type.
                            "id":String, //ID of the sub-task's Issue type.
                            "description":String, //Description of the sub-task's Issue type.
                            "iconUrl":String, //URL of the sub-task's Issue type icon
                            "name":String, //Name of the sub-task's Issue Type.
                            "subtask": "Boolean", //True when issue is a sub-task.
                            "avatarId": Number, //Number of the avatar ID of the issue.
                        }
                    }
                }
                {
                    //Second sub-task and so on.
                }
                ...
            ],
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"subtasks":
    		[
    			{
    				"id":"30103",
    				"key":"TEST-630",
    				"self":"https://jmwe-test-2.atlassian.net/rest/api/2/issue/30103",
    				"fields":
    				{
    					"summary":"Test",
    					"status":
    					{
    						"self":"https://jmwe-test-2.atlassian.net/rest/api/2/status/10000",
    						"description":"",
    						"iconUrl":"https://jmwe-test-2.atlassian.net/images/icons/status_generic.gif",
    						"name":"To Do",
    						"id":"10000",
    						"statusCategory":
    						{
    							"self":"https://jmwe-test-2.atlassian.net/rest/api/2/statuscategory/2",
    							"id":2,
    							"key":"new",
    							"colorName":"blue-gray",
    							"name":"To Do"
    						}
    					},
    					"priority":
    					{
    						"self":"https://jmwe-test-2.atlassian.net/rest/api/2/priority/3",
    						"iconUrl":"https://jmwe-test-2.atlassian.net/images/icons/priorities/medium.svg",
    						"name":"Medium",
    						"id":"3"
    					},
    					"issuetype":
    					{
    						"self":"https://jmwe-test-2.atlassian.net/rest/api/2/issuetype/10003",
    						"id":"10003",
    						"description":"The sub-task of the issue",
    						"iconUrl":"https://jmwe-test-2.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype",
    						"name":"Sub-task",
    						"subtask":true,
    						"avatarId":10316
    					}
    				}
    			}
    			{
    				//Second sub-task and so on..
    			}
    		],
    		...
    	}
    	...
    }
  • Accessing the Subtasks field: Only a small subset of the subtasks' fields (see the structure above) will be available from the subtasks field. To access all the fields of the subtasks use the subtasks filter instead.

Summary

  • Field name : Summary

  • Key: summary

  • Description : The Summary field is a string representation of a single-line text describing the summary of the issue.

  • Structure :

     Click here to see the structure of the Summary field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"summary": String, //Summary of the issue
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"summary":"Test issue",
    		...
    	}
    	...
    }
  • Accessing the Summary field
    • Summary of the issue : {{ issue.fields.summary }}

Time spent

  • Field name : Time Spent

  • Key: timespent

  • DescriptionThe Time spent field is a number representing the time spent on the issue in seconds.

  • Structure :

     Click here to see the structure of the Time spent field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"timespent": Number, //Time spent in seconds
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"timespent":28800,
    		...
    	}
    	...
    }
  • Accessing the Time spent field

Time tracking

  • Field name : Time Tracking

  • Key: timetracking

  • DescriptionThe Time tracking field is an object describing the time spent working on the issue.

  • Structure :

     Click here to see the structure of the Time tracking field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"timetracking":		
    		{
    			"originalEstimate": String, //Original estimate as a duration string
    			"remainingEstimate": String, //Remaining estimate as a duration string
    			"timeSpent":String, //Time spent as a duration string
    			"originalEstimateSeconds": Number, //Original estimate in seconds
    			"remainingEstimateSeconds": Number, //Remaining estimate in seconds
    			"timeSpentSeconds":Number //Time spent in seconds
    		},
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"timetracking":		
    		{
    			"originalEstimate":"1w",
    			"remainingEstimate":"1d",
    			"timeSpent":"1d",
    			"originalEstimateSeconds":144000,
    			"remainingEstimateSeconds":28800,
    			"timeSpentSeconds":28800
    		},
    		...
    	}
    	...
    }
  • Accessing the Time tracking field
    • Original Estimate of the issue as duration string : {{ issue.fields.timetracking.originalEstimate }}

    • Original Estimate of the issue in seconds : {{ issue.fields.timetracking.originalEstimateSeconds }}

    • Remaining Estimate of the issue as duration string : {{ issue.fields.timetracking.remainingEstimate }}
    • Remaining Estimate of the issue in seconds : {{ issue.fields.timetracking.remainingEstimateSeconds }}
    • Time Spent on the issue as a duration string : {{ issue.fields.timetracking.timeSpent }}
    • Time Spent on the issue in seconds : {{ issue.fields.timetracking.timeSpentSeconds }}

Updated

  • Field name : Updated

  • Key: updated

  • Description : The Updated field is a string representation of a date.

  • Structure :

     Click here to see the structure of the Updated field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"updated":String, //Updated datetime stamp
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"updated":"2016-10-13T08:54:51.253+0200",
    		...	
    	}
    	...
    }
  • Accessing the Updated field
    • Updated time stamp of the issue : {{ issue.fields.updated }}

You can use the date filter to manipulate and/or format the value

Votes

  • Field name : Votes

  • Key: votes

  • Description : The Votes field is an object describing the votes on the issue.

  • Structure :

     Click here to see the structure of Votes
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"votes": 
            {
                "self":String, //URL of the votes
                "votes":Number, //Number of votes
                "hasVoted":Boolean //True when the current user has voted
            },
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"votes":
    		{
    			"self":"https://jmwe-test-2.atlassian.net/rest/api/2/issue/TEST-629/votes",
    			"votes":0,
    			"hasVoted":false
    		},
    
    
    		...
    	}
    	...
    }
  • Accessing the Votes

    • Number of votes on the issue : {{issue.fields.votes.votes}}

Watchers

  • Field name : Watchers

  • Key: watches

  • DescriptionThe Watchers field is an object describing the watches on an issue.

  • Structure :

     Click here to see the structure of the Watchers field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    	"watches":
            {
                "self":String, //URL of the watches
                "watchCount":Number, //Number of the user watching the issue.
                "isWatching":Boolean //True if at least one user is watching the issue.
            },
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		watches":
    		{
    			"self":"https://jmwe-test-2.atlassian.net/rest/api/2/issue/TEST-623/watchers",
    			"watchCount":3,
    			"isWatching":true
    		},
    	...
    	}
    	...
    }
  • Accessing the Watchers field
    • Number of users watching the issue : {{ issue.fields.watches.watchcount }}

Work log

  • Field name : Log Work

  • Key: worklog

  • Description : The Work log field is an object with two fields:

    • worklog, containing an array of objects. Each object represents a single work log.

    • total, showing the total number of work logs.
  • Structure :

     Click here to see the structure of Worklog
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"worklog":
            {
                "total":Number, //Total seconds at which the work log started
                "worklogs": //Worklogs is an array of objects. Each log is an object in itself.
                [
                    {
                        "self":String, //URL of the work log of the issue
                        "author":
                        {
                            "self":String, //URL of the author
           					"accountId": String,
         				   	"emailAddress":String, //Email ID of the author
          				  	"avatarUrls":
    				        {
               					"48x48":String, //URL of the author
                				"24x24":String, //URL of the author
                				"16x16":String, //URL of the author
                				"32x32":String, //URL of the author
            				},
            				"displayName":String, //Display name of the author
            				"active":Boolean, //True when the author is active
            				"timeZone":String, //Time zone of the author
    						"accountType": String //Account type 
                        },
                        "updateAuthor":
                        {
                            "self":String, //URL of the update author
           					"accountId": String,
         				   	"emailAddress":String, //Email ID of the update author
          				  	"avatarUrls":
    				        {
               					"48x48":String, //URL of the update author
                				"24x24":String, //URL of the update author
                				"16x16":String, //URL of the update author
                				"32x32":String, //URL of the update author
            				},
            				"displayName":String, //Display name of the update author
            				"active":Boolean, //True when the update authoris active
            				"timeZone":String, //Time zone of the update author      
    						"accountType": String //Account type 
                        },
                        "comment":"",
                        "created":String, //Time stamp when the work log is created
                        "updated":String, //Time stamp when the work log is updated
                        "started":String, //Time stamp when the work log has started
                        "timeSpent":String, //Time spent
                        "timeSpentSeconds":Number, //Time spent in seconds
                        "id":String, //ID of the work log
                        "issueId":String //ID of the issue
                    },
                    {
    					//Second worklog and so on..
                    }
                        ...
                ]      
            }
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"worklog":
    		{
    			"total":1,
    			"worklogs":
    			[
    				{
    					"self":"https://jmwe-test-2.atlassian.net/rest/api/2/issue/30102/worklog/10901",
    					"author":
    					{
    						"self": "https://validationenvironment.atlassian.net/rest/api/2/user?accountId=5ca5b1469a000c1180956957",
    						"accountId": "accountId:5ca5b1469a000c1180956957",
    						"emailAddress":"rvijji@innovalog.com",
    						"avatarUrls":
    						{
    							"48x48":"https://jmwe-test-2.atlassian.net/secure/useravatar?avatarId=10337",
    							"24x24":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=small&avatarId=10337",
    							"16x16":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=xsmall&avatarId=10337",
    							"32x32":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=medium&avatarId=10337"
    						},
    						"displayName":"Radhika Vijji",
    						"active":true,
    						"timeZone":"Europe/Berlin",
    						"accountType": "atlassian"
    						},
    						"updateAuthor":
    						{
    							"self": "https://validationenvironment.atlassian.net/rest/api/2/user?accountId=5ca5b1469a000c1180956957",
    							"accountId": "accountId:5ca5b1469a000c1180956957",
    							"emailAddress":"rvijji@innovalog.com",
    							"avatarUrls":
    							{
    								"48x48":"https://jmwe-test-2.atlassian.net/secure/useravatar?avatarId=10337",
    								"24x24":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=small&avatarId=10337",
    								"16x16":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=xsmall&avatarId=10337",
    								"32x32":"https://jmwe-test-2.atlassian.net/secure/useravatar?size=medium&avatarId=10337"
    							},
    							"displayName":"Radhika Vijji",
    							"active":true,
    							"timeZone":"Europe/Berlin".
    							"accountType": "atlassian"
    						},
    						"comment":"",
    						"created":"2016-10-13T08:54:51.253+0200",
    						"updated":"2016-10-13T08:54:51.253+0200",
    						"started":"2016-10-13T08:54:00.000+0200",
    						"timeSpent":"1d",
    						"timeSpentSeconds":28800,
    						"id":"10901",
    						"issueId":"30102"
    					}
    					{
    						//Second work log and so on..
    					}
    				]
    			}
    			...
    		}
    		...
    	}
    	...
    }
  • Accessing the Worklog

    • Total number of work logs : {{issue.fields.worklog.total}}

Work Ratio

  • Field name : Work Ratio

  • Key: workratio

  • Description : The Work Ratio field is a number representing the ratio of work done on the issue.

  • Structure :

     Click here to see the structure of the Workratio field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"workratio":Number, //Workratio
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"workratio":20,
    		...	
    	}
    	...
    }
  • Accessing the Work Ratio field
    • Work ratio of the issue : {{ issue.fields.workratio }}

∑ Original Estimate

  • Field name : Σ Original Estimate

  • Key: aggregatetimeoriginalestimate

  • Description : The aggregate original Estimate field is a number representing the total original estimate of the issue and its sub-tasks, if the issue has any.

  • Structure :

     Click here to see the structure of Aggregate Original Estimate field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"aggregatetimeoriginalestimate":Number, //Aggregate original estimate in seconds
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"aggregatetimeoriginalestimate": 144000,
    		...
    	}
    	...
    }
  • Accessing the ∑ Original Estimate field
    • Aggregate original estimate of the issue in seconds : {{ issue.fields.aggregatetimeoriginalestimate }}

∑ Remaining Estimate

  • Field name : Σ Remaining Estimate

  • Key: aggregatetimeestimate

  • Description : The aggregate remaining Estimate field is a number representing the total remaining estimate of the issue and its sub-tasks, if the issue has any.

  • Structure :

     Click here to see the structure of Aggregate remaining Estimate field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"aggregatetimeestimate":Number, //Aggregate remaining estimate in seconds
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"aggregatetimeestimate": 28800,
    		...
    	}
    	...
    }
  • Accessing the ∑ Remaining Estimate field
    • Aggregate remaining estimate of the issue in seconds : {{ issue.fields.aggregatetimeestimate }}

∑ Progress

  • Field name : Σ Progress

  • Key: aggregateprogress

  • Description : The Aggregate Progress field is an object describing the aggregate progress on the issue.

  • Structure :

     Click here to see the structure of Aggregate Progress field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"aggregateprogress":
    		{
             	"progress":Number, //Aggregate Progress of the issue in seconds
                "total":Number, //Aggregate Total Progress of the issue in seconds
                "percent":Number //Aggregate Percentage of progress of issue
            },
    		...
    	},
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"aggregateprogress":
    		{
    			"progress":28800,
    			"total":57600,
    			"percent":50
    		},
    		...
    	}
    	...
    }
  • Accessing the ∑ Progress field
    • Aggregate Progress on the issue in seconds : {{ issue.fields.aggregateprogress.progress }}

    • Total progress on the issue in seconds : {{ issue.fields.aggregateprogress.total }}
    • Percentage of progress on the issue : {{ issue.fields.aggregateprogress.percent }}

∑ Time Spent

  • Field name : Σ Time Spent

  • Key: aggregatetimespent

  • Description : The Aggregate time spent field is a number representing the total time spent on the issue and its sub-tasks, if the issue has any.

  • Structure :

     Click here to see the structure of Aggregate time spent field
    Structure
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"aggregatetimespent":Number, //Aggregate original estimate in seconds
    		...
    	}
    	...
    }
    Example
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"aggregatetimespent": 288000,
    		...
    	}
    	...
    }
  • Accessing the ∑ Time spent field
    • Aggregate time spent on the issue in seconds : {{ issue.fields.aggregatetimespent }}