Basic Parameters
| Parameter | Description |
|---|---|
| Expand | Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: * renderedFields Returns field values rendered in HTML format.* names Returns the display name of each field.* schema Returns the schema describing a field type.* transitions Returns all possible transitions for the issue.* editmeta Returns information about how each field can be edited.* changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent.* versionedRepresentations Returns a JSON array for each version of a field’s value, with the highest number representing the most recent version. Note: When included in the request, the fields parameter is ignored. |
| Fields | A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: * *all Returns all fields.* *navigable Returns navigable fields.* Any issue field, prefixed with a minus to exclude. Examples: * summary,comment Returns only the summary and comments fields.* -description Returns all (default) fields except description.* *navigable,-comment Returns all navigable fields except comment.Note: All fields are returned by default. This differs from Search for issues using JQL (GET) and Search for issues using JQL (POST) where the default is all navigable fields. |
| Issue ID Or Key | The ID or key of the issue. Can be obtained via the List Issues action. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Properties | A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: * *all Returns all issue properties.* Any issue property key, prefixed with a minus to exclude. Examples: * *all Returns all properties.* *all,-prop1 Returns all properties except prop1.* prop1,prop2 Returns prop1 and prop2 properties.This parameter may be specified multiple times. For example, properties=prop1,prop2& properties=prop3. |
| Update History | Whether the project in which the issue is created is added to the user’s Recently viewed project list, as shown under Projects in Jira. This also populates the JQL issues search lastViewed field. |
Example Output
{
"expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
"id": "10002",
"self": "http://www.example.com/jira/rest/api/2/issue/10002",
"key": "EX-1",
"fields": {
"watcher": {
"self": "http://www.example.com/jira/rest/api/2/issue/EX-1/watchers",
"isWatching": false,
"watchCount": 1,
"watchers": [
{
"self": "http://www.example.com/jira/rest/api/2/user?username=fred",
"name": "fred",
"displayName": "Fred F. User",
"active": false
}
]
},
"attachment": [
{
"self": "http://www.example.com/jira/rest/api/2.0/attachments/10000",
"filename": "picture.jpg",
"author": {
"self": "http://www.example.com/jira/rest/api/2/user?username=fred",
"key": "JIRAUSER10100",
"name": "fred",
"emailAddress": "fred@example.com",
"avatarUrls": {
"48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred",
"24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred",
"16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred",
"32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred"
},
"displayName": "Fred F. User",
"active": true,
"deleted": false,
"timeZone": "Australia/Sydney",
"locale": "en_AU"
},
"created": "2022-11-15T02:47:10.492+0000",
"size": 23123,
"mimeType": "image/jpeg",
"content": "http://www.example.com/jira/attachments/10000",
"thumbnail": "http://www.example.com/jira/secure/thumbnail/10000"
}
],
"sub-tasks": [
{
"id": "10000",
"type": {
"id": "10000",
"name": "",
"inward": "Parent",
"outward": "Sub-task"
},
"outwardIssue": {
"id": "10003",
"key": "EX-2",
"self": "http://www.example.com/jira/rest/api/2/issue/EX-2",
"fields": {
"status": {
"iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
"name": "Open"
}
}
}
}
],
"description": "example bug report",
"project": {
"self": "http://www.example.com/jira/rest/api/2/project/EX",
"id": "10000",
"key": "EX",
"name": "Example",
"avatarUrls": {
"48x48": "http://www.example.com/jira/secure/projectavatar?size=large&pid=10000",
"24x24": "http://www.example.com/jira/secure/projectavatar?size=small&pid=10000",
"16x16": "http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000",
"32x32": "http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000"
},
"projectCategory": {
"self": "http://www.example.com/jira/rest/api/2/projectCategory/10000",
"id": "10000",
"name": "FIRST",
"description": "First Project Category"
}
},
"comment": [
{
"self": "http://www.example.com/jira/rest/api/2/issue/10010/comment/10000",
"id": "10000",
"author": {
"self": "http://www.example.com/jira/rest/api/2/user?username=fred",
"name": "fred",
"displayName": "Fred F. User",
"active": false
},
"body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
"updateAuthor": {
"self": "http://www.example.com/jira/rest/api/2/user?username=fred",
"name": "fred",
"displayName": "Fred F. User",
"active": false
},
"created": "2022-11-15T02:47:10.440+0000",
"updated": "2022-11-15T02:47:10.440+0000",
"visibility": {
"type": "role",
"value": "Administrators"
}
}
],
"issuelinks": [
{
"id": "10001",
"type": {
"id": "10000",
"name": "Dependent",
"inward": "depends on",
"outward": "is depended by"
},
"outwardIssue": {
"id": "10004L",
"key": "PRJ-2",
"self": "http://www.example.com/jira/rest/api/2/issue/PRJ-2",
"fields": {
"status": {
"iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
"name": "Open"
}
}
}
},
{
"id": "10002",
"type": {
"id": "10000",
"name": "Dependent",
"inward": "depends on",
"outward": "is depended by"
},
"inwardIssue": {
"id": "10004",
"key": "PRJ-3",
"self": "http://www.example.com/jira/rest/api/2/issue/PRJ-3",
"fields": {
"status": {
"iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
"name": "Open"
}
}
}
}
],
"worklog": [
{
"self": "http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000",
"author": {
"self": "http://www.example.com/jira/rest/api/2/user?username=fred",
"name": "fred",
"displayName": "Fred F. User",
"active": false
},
"updateAuthor": {
"self": "http://www.example.com/jira/rest/api/2/user?username=fred",
"name": "fred",
"displayName": "Fred F. User",
"active": false
},
"comment": "I did some work here.",
"updated": "2022-11-15T02:47:10.501+0000",
"visibility": {
"type": "group",
"value": "jira-developers"
},
"started": "2022-11-15T02:47:10.501+0000",
"timeSpent": "3h 20m",
"timeSpentSeconds": 12000,
"id": "100028",
"issueId": "10002"
}
],
"updated": 1,
"timetracking": {
"originalEstimate": "10m",
"remainingEstimate": "3m",
"timeSpent": "6m",
"originalEstimateSeconds": 600,
"remainingEstimateSeconds": 200,
"timeSpentSeconds": 400
}
},
"names": {
"watcher": "watcher",
"attachment": "attachment",
"sub-tasks": "sub-tasks",
"description": "description",
"project": "project",
"comment": "comment",
"issuelinks": "issuelinks",
"worklog": "worklog",
"updated": "updated",
"timetracking": "timetracking"
},
"schema": {}
}
Workflow Library Example
Get Issue with Jira Data Center and Send Results Via Email