This resource represents issue workflow statuses. Use it to obtain a list of all statuses associated with workflows and the details of a status.
Returns a list of all statuses associated with active workflows.
This operation can be accessed anonymously.
Permissions required: None.
Connect app scope required: READ
read:jira-workread:status:jiraThis request has no parameters.
Returned if the request is successful.
array<StatusDetails>
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/status`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.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
[
{
"description": "The issue is currently being worked on.",
"iconUrl": "https://your-domain.atlassian.net/images/icons/progress.gif",
"id": "10000",
"name": "In Progress",
"self": "https://your-domain.atlassian.net/rest/api/2/status/10000",
"statusCategory": {
"colorName": "yellow",
"id": 1,
"key": "in-flight",
"name": "In Progress",
"self": "https://your-domain.atlassian.net/rest/api/2/statuscategory/1"
}
},
{
"description": "The issue is closed.",
"iconUrl": "https://your-domain.atlassian.net/images/icons/closed.gif",
"id": "5",
"name": "Closed",
"self": "https://your-domain.atlassian.net/rest/api/2/status/5",
"statusCategory": {
"colorName": "green",
"id": 9,
"key": "completed",
"self": "https://your-domain.atlassian.net/rest/api/2/statuscategory/9"
}
}
]Returns a status. The status must be associated with an active workflow to be returned.
If a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable.
This operation can be accessed anonymously.
Permissions required: None.
Connect app scope required: READ
read:jira-workread:status:jirastring
RequiredReturned if the request is successful.
A status.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/status/{idOrName}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"description": "The issue is currently being worked on.",
"iconUrl": "https://your-domain.atlassian.net/images/icons/progress.gif",
"id": "10000",
"name": "In Progress",
"self": "https://your-domain.atlassian.net/rest/api/2/status/10000",
"statusCategory": {
"colorName": "yellow",
"id": 1,
"key": "in-flight",
"name": "In Progress",
"self": "https://your-domain.atlassian.net/rest/api/2/statuscategory/1"
}
}Rate this page: