Rate this page:
Apis related to issues
PUT /rest/agile/1.0/issue/rank
Moves (ranks) issues before or after a given issue. At most 50 issues may be ranked at once.
Connect app scope required: WRITE
Array<string>
string
string
integer
int641 2 3 4 5 6 7 8 9 10 11
curl --request PUT \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/issue/rank' \
--header 'Content-Type: application/json' \
--data '{
"issues": [
"<string>"
],
"rankBeforeIssue": "<string>",
"rankAfterIssue": "<string>",
"rankCustomFieldId": 2154
}'Empty response is returned if operation was successful.
GET /rest/agile/1.0/issue/{issueIdOrKey}
Returns a single issue, for a given issue ID or issue key. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic.
Connect app scope required: READ
string
The ID or key of the requested issue.
Array<string>
The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
string
A comma-separated list of the parameters to expand.
boolean
A boolean indicating whether the issue retrieved by this method should be added to the current user's issue history
1 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/issue/{issueIdOrKey}' \
--header 'Accept: application/json'Returns the requested issue.
| Content type | Value |
|---|---|
| application/json | anything |
Example response (application/json)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
{
"expand": "",
"id": "10001",
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001",
"key": "HSP-1",
"fields": {
"flagged": true,
"sprint": {
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
"state": "future",
"name": "sprint 2",
"goal": "sprint 2 goal"
},
"closedSprints": [
{
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
"state": "closed",
"name": "sprint 1",
"startDate": "2015-04-11T15:22:00.000+10:00",
"endDate": "2015-04-20T01:22:00.000+10:00",
"completeDate": "2015-04-20T11:04:00.000+10:00",
"goal": "sprint 1 goal"
}
],
"description": "example bug report",
"project": {
"self": "https://your-domain.atlassian.net/rest/api/~ver~/project/EX",
"id": "10000",
"key": "EX",
"name": "Example",
"avatarUrls": {
"48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000",
"24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
"16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
"32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000"
},
"projectCategory": {
"self": "https://your-domain.atlassian.net/rest/api/~ver~/projectCategory/10000",
"id": "10000",
"name": "FIRST",
"description": "First Project Category"
},
"simplified": false,
"style": "classic",
"insight": {
"totalIssueCount": 100,
"lastIssueUpdateTime": "2021-09-27T01:40:48.769+0000"
}
},
"comment": [
{
"self": "https://your-domain.atlassian.net/rest/api/~ver~/issue/10010/comment/10000",
"id": "10000",
"author": {
"self": "https://your-domain.atlassian.net/rest/api/~ver~/user?accountId=5b10a2844c20165700ede21g",
"accountId": "5b10a2844c20165700ede21g",
"displayName": "Mia Krystof",
"active": false
},
"body": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "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": "https://your-domain.atlassian.net/rest/api/~ver~/user?accountId=5b10a2844c20165700ede21g",
"accountId": "5b10a2844c20165700ede21g",
"displayName": "Mia Krystof",
"active": false
},
"created": "2021-09-27T01:40:48.931+0000",
"updated": "2021-09-27T01:40:48.931+0000",
"visibility": {
"type": "role",
"value": "Administrators"
}
}
],
"epic": {
"id": 37,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
"name": "epic 1",
"summary": "epic 1 summary",
"color": {
"key": "color_4"
},
"done": true
},
"worklog": [
{
"self": "https://your-domain.atlassian.net/rest/api/~ver~/issue/10010/worklog/10000",
"author": {
"self": "https://your-domain.atlassian.net/rest/api/~ver~/user?accountId=5b10a2844c20165700ede21g",
"accountId": "5b10a2844c20165700ede21g",
"displayName": "Mia Krystof",
"active": false
},
"updateAuthor": {
"self": "https://your-domain.atlassian.net/rest/api/~ver~/user?accountId=5b10a2844c20165700ede21g",
"accountId": "5b10a2844c20165700ede21g",
"displayName": "Mia Krystof",
"active": false
},
"comment": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "I did some work here."
}
]
}
]
},
"updated": "2021-09-27T01:40:48.935+0000",
"visibility": {
"type": "group",
"value": "jira-developers"
},
"started": "2021-09-27T01:40:48.935+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
}
}
}GET /rest/agile/1.0/issue/{issueIdOrKey}/estimation
Returns the estimation of the issue and a fieldId of the field that is used for it. boardId param is required. This param determines which field will be updated on a issue.
Connect app scope required: READ
string
The ID or key of the requested issue.
integer
The ID of the board required to determine which field is used for estimation.
int641 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/issue/{issueIdOrKey}/estimation' \
--header 'Accept: application/json'Returns the estimation of the issue and a fieldId of the field that is used for it.
| Content type | Value |
|---|---|
| application/json | anything |
Example response (application/json)
1 2 3 4
{
"fieldId": "customfield_12532",
"value": "8.0"
}PUT /rest/agile/1.0/issue/{issueIdOrKey}/estimation
Updates the estimation of the issue. boardId param is required. This param determines which field will be updated on a issue.
Connect app scope required: WRITE
string
The ID or key of the requested issue.
integer
The ID of the board required to determine which field is used for estimation.
int64string
1 2 3 4 5 6 7
curl --request PUT \
--url 'https://your-domain.atlassian.net/rest/agile/1.0/issue/{issueIdOrKey}/estimation' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"value": "<string>"
}'Returns the estimation of the issue and a fieldId of the field that is used for it.
| Content type | Value |
|---|---|
| application/json | anything |
Example response (application/json)
1 2 3 4
{
"fieldId": "customfield_12532",
"value": "8.0"
}Rate this page: