Versions Compared

Key

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

...

Panel
borderStylesolid

Subtasks

  • Field name : Sub-tasks

  • Key: subtasks

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

  • Structure :

    Expand
    titleClick here to see the structure of subtasks


    Section


    Column


    Code Block
    titleStructure
    linenumberstrue
    "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.
                }
                ...
            ],
    		...
    	}
    	...
    }

    Note that only a small subset of the subtasks' fields will be present. A much easier way to access subtasks is through the use of the subtasks filter.



    Column
    width700px


    Code Block
    titleExample
    linenumberstrue
    "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 Issue links field: use the subtasks filter instead 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.


Panel
borderStylesolid

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 :

    Expand
    titleClick here to see the structure of the Summary field


    Section


    Column


    Code Block
    titleStructure
    linenumberstrue
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"summary": String, //Summary of the issue
    		...
    	}
    	...
    }



    Column
    width700px


    Code Block
    titleExample
    linenumberstrue
    "issue":
    {
    	...
    	...
    	"fields":
    	{
    		...
    		...
    		"summary":"Test issue",
    		...
    	}
    	...
    }





  • Accessing the Summary field
    • Summary of the issue : {{ issue.fields.summary }}

...