Backlog
Board
Epic
Issue
Sprint
Development Information
Feature Flags
Deployments
Builds
Remote Links
Other operations

Rate this page:

Issue

Apis related to issues

Rank 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.

This operation may fail for some issues, although this will be rare. In that case the 207 status code is returned for the whole response and detailed information regarding each issue is available in the response body.

If rankCustomFieldId is not defined, the default rank field will be used.

Connect app scope required: WRITE

OAuth scopes required: 
write:issue:jira-software

Request

Body parameters
issues

Array<string>

rankBeforeIssue

string

rankAfterIssue

string

rankCustomFieldId

integer

Format: int64

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
  --url 'https://your-domain.atlassian.com/rest/agile/1.0/issue/rank' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "rankBeforeIssue": "PR-4",
  "rankCustomFieldId": 10521,
  "issues": [
    "PR-1",
    "10001",
    "PR-3"
  ]
}'

Responses

Empty response is returned if operation was successful.

Get issue

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

OAuth scopes required: 
read:issue:jira-software

Request

Path parameters
issueIdOrKey Required

string

The ID or key of the requested issue.

Query parameters
fields

Array<object>

The list of fields to return for each issue. By default, all navigable and Agile fields are returned.

expand

string

A comma-separated list of the parameters to expand.

updateHistory

boolean

A boolean indicating whether the issue retrieved by this method should be added to the current user's issue history

Example

1
2
3
4
curl --request GET \
  --url 'https://your-domain.atlassian.com/rest/agile/1.0/issue/{issueIdOrKey}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Returns the requested issue.

Content typeValue
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
154
155
{
  "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/3/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/3/projectCategory/10000",
        "id": "10000",
        "name": "FIRST",
        "description": "First Project Category"
      },
      "simplified": false,
      "style": "classic",
      "insight": {
        "totalIssueCount": 100,
        "lastIssueUpdateTime": "2022-05-11T23:23:57.603+0000"
      }
    },
    "comment": [
      {
        "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
        "id": "10000",
        "author": {
          "self": "https://your-domain.atlassian.net/rest/api/3/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/3/user?accountId=5b10a2844c20165700ede21g",
          "accountId": "5b10a2844c20165700ede21g",
          "displayName": "Mia Krystof",
          "active": false
        },
        "created": "2021-01-17T12:34:00.000+0000",
        "updated": "2021-01-18T23:45:00.000+0000",
        "visibility": {
          "type": "role",
          "value": "Administrators",
          "identifier": "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/3/issue/10010/worklog/10000",
        "author": {
          "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
          "accountId": "5b10a2844c20165700ede21g",
          "displayName": "Mia Krystof",
          "active": false
        },
        "updateAuthor": {
          "self": "https://your-domain.atlassian.net/rest/api/3/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-01-18T23:45:00.000+0000",
        "visibility": {
          "type": "group",
          "value": "jira-developers",
          "identifier": "276f955c-63d7-42c8-9520-92d01dca0625"
        },
        "started": "2021-01-17T12:34:00.000+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 issue estimation for board

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.

Original time internally stores and returns the estimation as a number of seconds.

The field used for estimation on the given board can be obtained from board configuration resource. More information about the field are returned by edit meta resource or field resource.

Connect app scope required: READ

OAuth scopes required: 
read:issue:jira-software
, read:issue-details:jira

Request

Path parameters
issueIdOrKey Required

string

The ID or key of the requested issue.

Query parameters
boardId

integer

The ID of the board required to determine which field is used for estimation.

Format: int64

Example

1
2
3
4
curl --request GET \
  --url 'https://your-domain.atlassian.com/rest/agile/1.0/issue/{issueIdOrKey}/estimation' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Returns the estimation of the issue and a fieldId of the field that is used for it.

Content typeValue
application/json

anything

Example response (application/json)

1
2
3
4
{
  "fieldId": "customfield_12532",
  "value": "8.0"
}

Estimate issue for board

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.

Note that this resource changes the estimation field of the issue regardless of appearance the field on the screen.

Original time tracking estimation field accepts estimation in formats like "1w", "2d", "3h", "20m" or number which represent number of minutes. However, internally the field stores and returns the estimation as a number of seconds.

The field used for estimation on the given board can be obtained from board configuration resource. More information about the field are returned by edit meta resource or field resource.

Connect app scope required: WRITE

OAuth scopes required: 
write:issue:jira-software
, read:issue-details:jira

Request

Path parameters
issueIdOrKey Required

string

The ID or key of the requested issue.

Query parameters
boardId

integer

The ID of the board required to determine which field is used for estimation.

Format: int64
Body parameters
value

string

Example

1
2
3
4
5
6
7
8
curl --request PUT \
  --url 'https://your-domain.atlassian.com/rest/agile/1.0/issue/{issueIdOrKey}/estimation' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "value": "8.0"
}'

Responses

Returns the estimation of the issue and a fieldId of the field that is used for it.

Content typeValue
application/json

anything

Example response (application/json)

1
2
3
4
{
  "fieldId": "customfield_12532",
  "value": "8.0"
}

Rate this page: