This resource represents statuses. Use it to search, get, create, delete, and change statuses.
Returns a list of the statuses specified by one or more status IDs.
Permissions required:
manage:jira-configurationread:workflow:jiraConnect app scope required: READ
string
array<string>
RequiredReturned if the request is successful.
array<JiraStatus>
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/3/statuses?id={id}`, {
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
30
[
{
"description": "The issue is resolved",
"id": "1000",
"name": "Finished",
"scope": {
"project": {
"id": "1"
},
"type": "PROJECT"
},
"statusCategory": "DONE",
"usages": [
{
"issueTypes": [
"10002"
],
"project": {
"id": "1"
}
}
],
"workflowUsages": [
{
"workflowId": "545d80a3-91ff-4949-8b0d-a2bc484e70e5",
"workflowName": "Workflow 1"
}
]
}
]Updates statuses by ID.
Permissions required:
manage:jira-configurationwrite:workflow:jiraConnect app scope required: ADMIN
The list of statuses that will be updated.
array<StatusUpdate>
RequiredReturned if the request is successful.
any
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"statuses": [
{
"description": "The issue is resolved",
"id": "1000",
"name": "Finished",
"statusCategory": "DONE"
}
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/statuses`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Creates statuses for a global or project scope.
Permissions required:
manage:jira-configurationwrite:workflow:jiraConnect app scope required: ADMIN
Details of the statuses being created and their scope.
StatusScope
Requiredarray<StatusCreate>
RequiredReturned if the request is successful.
array<JiraStatus>
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"scope": {
"project": {
"id": "1"
},
"type": "PROJECT"
},
"statuses": [
{
"description": "The issue is resolved",
"name": "Finished",
"statusCategory": "DONE"
}
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/statuses`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
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
[
{
"description": "The issue is resolved",
"id": "1000",
"name": "Finished",
"scope": {
"project": {
"id": "1"
},
"type": "PROJECT"
},
"statusCategory": "DONE",
"usages": [],
"workflowUsages": []
}
]Deletes statuses by ID.
Permissions required:
manage:jira-configurationwrite:workflow:jiraConnect app scope required: ADMIN
array<string>
RequiredReturned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
// 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/3/statuses?id={id}`, {
method: 'DELETE',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returns a paginated list of statuses that match a search on name or project.
Permissions required:
manage:jira-configurationread:workflow:jiraConnect app scope required: READ
string
string
integer
integer
string
string
Returned if the request is successful.
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/3/statuses/search`, {
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
30
31
32
33
34
35
36
37
38
{
"isLast": true,
"maxResults": 2,
"nextPage": "https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=2&maxResults=2",
"self": "https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=0&maxResults=2",
"startAt": 0,
"total": 5,
"values": [
{
"description": "The issue is resolved",
"id": "1000",
"name": "Finished",
"scope": {
"project": {
"id": "1"
},
"type": "PROJECT"
},
"statusCategory": "DONE",
"usages": [
{
"issueTypes": [
"10002"
],
"project": {
"id": "1"
}
}
],
"workflowUsages": [
{
"workflowId": "545d80a3-91ff-4949-8b0d-a2bc484e70e5",
"workflowName": "Workflow 1"
}
]
}
]
}Returns a page of issue types in a project using a given status.
manage:jira-configurationread:project:jira, read:status:jira, read:issue-type:jiraConnect app scope required: READ
string
Requiredstring
Requiredstring
integer
Returned if the request is successful.
The issue types using this status in a project.
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/3/statuses/{statusId}/project/{projectId}/issueTypeUsages`, {
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
{
"issueTypes": {
"nextPageToken": "eyJvIjoyfQ==",
"values": [
{
"id": "1000"
}
]
},
"projectId": "2000",
"statusId": "1000"
}Returns a page of projects using a given status.
manage:jira-configurationread:project:jira, read:status:jiraConnect app scope required: READ
string
Requiredstring
integer
Returned if the request is successful.
The projects using this 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/3/statuses/{statusId}/projectUsages`, {
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
{
"projects": {
"nextPageToken": "eyJvIjoyfQ==",
"values": [
{
"id": "1000"
}
]
},
"statusId": "1000"
}Returns a page of workflows using a given status.
manage:jira-configurationread:workflow:jira, read:status:jiraConnect app scope required: READ
string
Requiredstring
integer
Returned if the request is successful.
Workflows using the 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/3/statuses/{statusId}/workflowUsages`, {
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
{
"statusId": "1000",
"workflows": {
"nextPageToken": "eyJvIjoyfQ==",
"values": [
{
"id": "545d80a3-91ff-4949-8b0d-a2bc484e70e5"
}
]
}
}Rate this page: