This resource represents screen schemes in classic projects. Use it to get, create, update, and delete screen schemes.
Returns a paginated list of screen schemes.
Only screen schemes used in classic projects are returned.
Permissions required: Administer Jira global permission.
manage:jira-projectread:screen-scheme:jira, read:issue-type-screen-scheme:jiraConnect app scope required: ADMIN
integer
integer
array<integer>
string
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/screenscheme`, {
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
{
"isLast": true,
"maxResults": 100,
"self": "https://your-domain.atlassian.net/rest/api/3/screenscheme?maxResults=25&startAt=0",
"startAt": 0,
"total": 2,
"values": [
{
"id": 10010,
"name": "Employee screen scheme",
"description": "Manage employee data",
"screens": {
"default": 10017,
"edit": 10019,
"create": 10019,
"view": 10020
},
"issueTypeScreenSchemes": {
"isLast": true,
"maxResults": 100,
"startAt": 0,
"total": 1,
"values": [
{
"id": "10000",
"name": "Office issue type screen scheme",
"description": "Managing office projects"
}
]
}
},
{
"id": 10032,
"name": "Office screen scheme",
"description": "Manage office data",
"screens": {
"default": 10020
}
}
]
}Creates a screen scheme.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:screen-scheme:jiraConnect app scope required: ADMIN
string
string
RequiredScreenTypes
RequiredReturned if the request is successful.
The ID of a screen 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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"description": "Manage employee data",
"name": "Employee screen scheme",
"screens": {
"default": 10017,
"edit": 10019,
"view": 10020
}
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/screenscheme`, {
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
}Updates a screen scheme. Only screen schemes used in classic projects can be updated.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:screen-scheme:jiraConnect app scope required: ADMIN
string
RequiredThe screen scheme update details.
string
string
UpdateScreenTypes
Returned 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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"name": "Employee screen scheme v2",
"screens": {
"create": "10019",
"default": "10018"
}
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/screenscheme/{screenSchemeId}`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme.
Only screens schemes used in classic projects can be deleted.
Permissions required: Administer Jira global permission.
manage:jira-projectdelete:screen-scheme:jiraConnect app scope required: ADMIN
string
RequiredReturned if the screen scheme is deleted.
1
2
3
4
5
6
7
8
9
10
// 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/screenscheme/{screenSchemeId}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Rate this page: