This resource represents issue priority schemes. Use it to get priority schemes and related information, and to create, update and delete priority schemes.
Returns a paginated list of priority schemes.
Permissions required: Permission to access Jira.
manage:jira-configurationConnect app scope required: READ
string
string
array<integer>
array<integer>
string
boolean
string
string
Returned if the request is successful.
A page of items.
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/priorityscheme`, {
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
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
{
"isLast": true,
"maxResults": 50,
"startAt": 0,
"total": 1,
"values": [
{
"description": "This is the default scheme used by all new and unassigned projects",
"id": "1",
"isDefault": true,
"name": "Default Priority Scheme",
"priorities": {
"isLast": true,
"maxResults": 50,
"startAt": 0,
"total": 3,
"values": [
{
"description": "Serious problem that could block progress.",
"iconUrl": "/images/icons/priorities/high.svg",
"id": "1",
"isDefault": false,
"name": "High",
"statusColor": "#f15C75"
},
{
"description": "Has the potential to affect progress.",
"iconUrl": "/images/icons/priorities/medium.svg",
"id": "2",
"isDefault": true,
"name": "Medium",
"statusColor": "#f79232"
},
{
"description": "Minor problem or easily worked around.",
"iconUrl": "/images/icons/priorities/low.svg",
"id": "3",
"isDefault": false,
"name": "Low",
"statusColor": "#707070"
}
]
},
"projects": {
"isLast": true,
"maxResults": 50,
"startAt": 0,
"total": 1,
"values": [
{
"avatarUrls": {
"16x16": "secure/projectavatar?size=xsmall&pid=10000",
"24x24": "secure/projectavatar?size=small&pid=10000",
"32x32": "secure/projectavatar?size=medium&pid=10000",
"48x48": "secure/projectavatar?size=large&pid=10000"
},
"id": "10000",
"key": "EX",
"name": "Example",
"projectCategory": {
"description": "Project category description",
"id": "10000",
"name": "A project category"
},
"projectTypeKey": "ProjectTypeKey{key='software'}",
"self": "project/EX",
"simplified": false
}
]
}
}
]
}Creates a new priority scheme.
Permissions required: Administer Jira global permission.
manage:jira-configurationConnect app scope required: ADMIN
integer
Requiredstring
PriorityMapping
string
Requiredarray<integer>
Requiredarray<integer>
Returned if the request is completed.
The ID of a priority scheme.
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"defaultPriorityId": 10001,
"description": "My priority scheme description",
"mappings": {
"in": {
"10002": 10000,
"10005": 10001,
"10006": 10001,
"10008": 10003
},
"out": {}
},
"name": "My new priority scheme",
"priorityIds": [
10000,
10001,
10003
],
"projectIds": [
10005,
10006,
10007
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/priorityscheme`, {
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
{
"id": "10001"
}Returns a paginated list of priorities that would require mapping, given a change in priorities or projects associated with a priority scheme.
Permissions required: Permission to access Jira.
manage:jira-configurationConnect app scope required: ADMIN
integer
SuggestedMappingsForPrioritiesRequestBean
SuggestedMappingsForProjectsRequestBean
integer
integer
Returned if the request is successful.
A page of items.
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"maxResults": 50,
"priorities": {
"add": [
10001,
10002
],
"remove": [
10003
]
},
"projects": {
"add": [
10021
]
},
"schemeId": 10005,
"startAt": 0
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/priorityscheme/mappings`, {
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
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
"isLast": true,
"maxResults": 50,
"startAt": 0,
"total": 3,
"values": [
{
"description": "Serious problem that could block progress.",
"iconUrl": "/images/icons/priorities/high.svg",
"id": "1",
"isDefault": false,
"name": "High",
"statusColor": "#f15C75"
},
{
"description": "Has the potential to affect progress.",
"iconUrl": "/images/icons/priorities/medium.svg",
"id": "2",
"isDefault": true,
"name": "Medium",
"statusColor": "#f79232"
},
{
"description": "Minor problem or easily worked around.",
"iconUrl": "/images/icons/priorities/low.svg",
"id": "3",
"isDefault": false,
"name": "Low",
"statusColor": "#707070"
}
]
}Returns a paginated list of priorities available for adding to a priority scheme.
Permissions required: Permission to access Jira.
manage:jira-configurationConnect app scope required: READ
string
string
string
string
Requiredarray<string>
Returned if the request is successful.
A page of items.
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/priorityscheme/priorities/available?schemeId={schemeId}`, {
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
{
"isLast": true,
"maxResults": 50,
"startAt": 0,
"total": 3,
"values": [
{
"description": "Serious problem that could block progress.",
"iconUrl": "/images/icons/priorities/high.svg",
"id": "1",
"isDefault": false,
"name": "High",
"statusColor": "#f15C75"
},
{
"description": "Has the potential to affect progress.",
"iconUrl": "/images/icons/priorities/medium.svg",
"id": "2",
"isDefault": true,
"name": "Medium",
"statusColor": "#f79232"
},
{
"description": "Minor problem or easily worked around.",
"iconUrl": "/images/icons/priorities/low.svg",
"id": "3",
"isDefault": false,
"name": "Low",
"statusColor": "#707070"
}
]
}Updates a priority scheme. This includes its details, the lists of priorities and projects in it
Permissions required: Administer Jira global permission.
manage:jira-configurationConnect app scope required: ADMIN
integer
Requiredinteger
string
PriorityMapping
string
UpdatePrioritiesInSchemeRequestBean
UpdateProjectsInSchemeRequestBean
Returned if the request is accepted.
Details of the updated priority scheme.
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"defaultPriorityId": 10001,
"description": "My priority scheme description",
"mappings": {
"in": {
"10003": 10002,
"10004": 10001
},
"out": {
"10001": 10005,
"10002": 10006
}
},
"name": "My new priority scheme",
"priorities": {
"add": {
"ids": [
10001,
10002
]
},
"remove": {
"ids": [
10003,
10004
]
}
},
"projects": {
"add": {
"ids": [
10101,
10102
]
},
"remove": {
"ids": [
10103,
10104
]
}
}
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/priorityscheme/{schemeId}`, {
method: 'PUT',
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
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
{
"task": {
"self": "https://your-domain.atlassian.net/rest/api/3/task/1",
"id": "1",
"description": "Task description",
"status": "COMPLETE",
"result": "the task result, this may be any JSON",
"submittedBy": 10000,
"progress": 100,
"elapsedRuntime": 156,
"submitted": 1501708132800,
"started": 1501708132900,
"finished": 1501708133000,
"lastUpdate": 1501708133000
},
"updated": {
"description": "This is the default scheme used by all new and unassigned projects",
"id": "1",
"isDefault": true,
"name": "Default Priority Scheme",
"priorities": {
"isLast": true,
"maxResults": 50,
"startAt": 0,
"total": 3,
"values": [
{
"description": "Serious problem that could block progress.",
"iconUrl": "/images/icons/priorities/high.svg",
"id": "1",
"isDefault": false,
"name": "High",
"statusColor": "#f15C75"
},
{
"description": "Has the potential to affect progress.",
"iconUrl": "/images/icons/priorities/medium.svg",
"id": "2",
"isDefault": true,
"name": "Medium",
"statusColor": "#f79232"
},
{
"description": "Minor problem or easily worked around.",
"iconUrl": "/images/icons/priorities/low.svg",
"id": "3",
"isDefault": false,
"name": "Low",
"statusColor": "#707070"
}
]
},
"projects": {
"isLast": true,
"maxResults": 50,
"startAt": 0,
"total": 1,
"values": [
{
"avatarUrls": {
"16x16": "secure/projectavatar?size=xsmall&pid=10000",
"24x24": "secure/projectavatar?size=small&pid=10000",
"32x32": "secure/projectavatar?size=medium&pid=10000",
"48x48": "secure/projectavatar?size=large&pid=10000"
},
"id": "10000",
"key": "EX",
"name": "Example",
"projectCategory": {
"description": "Project category description",
"id": "10000",
"name": "A project category"
},
"projectTypeKey": "ProjectTypeKey{key='software'}",
"self": "project/EX",
"simplified": false
}
]
}
}
}Deletes a priority scheme.
This operation is only available for priority schemes without any associated projects. Any associated projects must be removed from the priority scheme before this operation can be performed.
Permissions required: Administer Jira global permission.
manage:jira-configurationConnect app scope required: ADMIN
integer
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/priorityscheme/{schemeId}`, {
method: 'DELETE',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returns a paginated list of priorities by scheme.
Permissions required: Permission to access Jira.
manage:jira-configurationConnect app scope required: READ
string
Requiredstring
string
Returned if the request is successful.
A page of items.
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/priorityscheme/{schemeId}/priorities`, {
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
{
"isLast": true,
"maxResults": 50,
"startAt": 0,
"total": 3,
"values": [
{
"description": "Serious problem that could block progress.",
"iconUrl": "/images/icons/priorities/high.svg",
"id": "1",
"isDefault": false,
"name": "High",
"statusColor": "#f15C75"
},
{
"description": "Has the potential to affect progress.",
"iconUrl": "/images/icons/priorities/medium.svg",
"id": "2",
"isDefault": true,
"name": "Medium",
"statusColor": "#f79232"
},
{
"description": "Minor problem or easily worked around.",
"iconUrl": "/images/icons/priorities/low.svg",
"id": "3",
"isDefault": false,
"name": "Low",
"statusColor": "#707070"
}
]
}Returns a paginated list of projects by scheme.
Permissions required: Permission to access Jira.
manage:jira-configurationConnect app scope required: READ
string
Requiredstring
string
array<integer>
string
Returned if the request is successful.
A page of items.
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/priorityscheme/{schemeId}/projects`, {
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
{
"isLast": true,
"maxResults": 50,
"startAt": 0,
"total": 1,
"values": [
{
"avatarUrls": {
"16x16": "secure/projectavatar?size=xsmall&pid=10000",
"24x24": "secure/projectavatar?size=small&pid=10000",
"32x32": "secure/projectavatar?size=medium&pid=10000",
"48x48": "secure/projectavatar?size=large&pid=10000"
},
"id": "10000",
"key": "EX",
"name": "Example",
"projectCategory": {
"description": "Project category description",
"id": "10000",
"name": "A project category"
},
"projectTypeKey": "ProjectTypeKey{key='software'}",
"self": "project/EX",
"simplified": false
}
]
}Rate this page: