This resource represents issue type screen schemes. Use it to:
Returns a paginated list of issue type screen schemes.
Only issue type screen schemes used in classic projects are returned.
Permissions required: Administer Jira global permission.
manage:jira-configurationread: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/issuetypescreenscheme`, {
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
{
"isLast": true,
"maxResults": 100,
"startAt": 0,
"total": 2,
"values": [
{
"id": "1",
"name": "Default Issue Type Screen Scheme",
"description": "The default issue type screen scheme"
},
{
"id": "10000",
"name": "Office issue type screen scheme",
"description": "Managing office projects",
"projects": {
"isLast": true,
"maxResults": 100,
"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 an issue type screen scheme.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:issue-type-screen-scheme:jiraConnect app scope required: ADMIN
An issue type screen scheme bean.
string
array<IssueTypeScreenSchemeMapping>
Requiredstring
RequiredReturned if the request is successful.
The ID of an issue type 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
26
27
28
29
30
31
32
33
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"issueTypeMappings": [
{
"issueTypeId": "default",
"screenSchemeId": "10001"
},
{
"issueTypeId": "10001",
"screenSchemeId": "10002"
},
{
"issueTypeId": "10002",
"screenSchemeId": "10002"
}
],
"name": "Scrum issue type screen scheme"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme`, {
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 issue type screen scheme items.
Only issue type screen schemes used in classic projects are returned.
Permissions required: Administer Jira global permission.
manage:jira-configurationread:issue-type-screen-scheme:jiraConnect app scope required: ADMIN
integer
integer
array<integer>
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/issuetypescreenscheme/mapping`, {
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
{
"isLast": true,
"maxResults": 100,
"startAt": 0,
"total": 4,
"values": [
{
"issueTypeId": "10000",
"issueTypeScreenSchemeId": "10020",
"screenSchemeId": "10010"
},
{
"issueTypeId": "10001",
"issueTypeScreenSchemeId": "10021",
"screenSchemeId": "10010"
},
{
"issueTypeId": "10002",
"issueTypeScreenSchemeId": "10022",
"screenSchemeId": "10010"
},
{
"issueTypeId": "default",
"issueTypeScreenSchemeId": "10023",
"screenSchemeId": "10011"
}
]
}Returns a paginated list of issue type screen schemes and, for each issue type screen scheme, a list of the projects that use it.
Only issue type screen schemes used in classic projects are returned.
Permissions required: Administer Jira global permission.
manage:jira-configurationread:issue-type-screen-scheme:jiraConnect app scope required: ADMIN
integer
integer
array<integer>
RequiredReturned 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/issuetypescreenscheme/project?projectId={projectId}`, {
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
{
"isLast": true,
"maxResults": 100,
"startAt": 0,
"total": 1,
"values": [
{
"issueTypeScreenScheme": {
"id": "1",
"name": "Default Issue Type Screen Scheme",
"description": "The default issue type screen scheme"
},
"projectIds": [
"10000",
"10001"
]
}
]
}Assigns an issue type screen scheme to a project.
Issue type screen schemes can only be assigned to classic projects.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:issue-type-screen-scheme:jira, write:project:jiraConnect app scope required: ADMIN
string
string
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"issueTypeScreenSchemeId": "10001",
"projectId": "10002"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/project`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Updates an issue type screen scheme.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:issue-type-screen-scheme:jiraConnect app scope required: ADMIN
string
RequiredThe issue type screen scheme update details.
string
string
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"description": "Screens for scrum issue types.",
"name": "Scrum scheme"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}`, {
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 an issue type screen scheme.
Permissions required: Administer Jira global permission.
manage:jira-configurationdelete:issue-type-screen-scheme:jiraConnect app scope required: ADMIN
string
RequiredReturned if the issue type screen scheme is deleted.
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/issuetypescreenscheme/{issueTypeScreenSchemeId}`, {
method: 'DELETE',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Appends issue type to screen scheme mappings to an issue type screen scheme.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:issue-type-screen-scheme:jiraConnect app scope required: ADMIN
string
Requiredarray<IssueTypeScreenSchemeMapping>
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
27
28
29
30
31
32
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"issueTypeMappings": [
{
"issueTypeId": "10000",
"screenSchemeId": "10001"
},
{
"issueTypeId": "10001",
"screenSchemeId": "10002"
},
{
"issueTypeId": "10002",
"screenSchemeId": "10002"
}
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Updates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:issue-type-screen-scheme:jiraConnect app scope required: ADMIN
string
Requiredstring
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"screenSchemeId": "10010"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Removes issue type to screen scheme mappings from an issue type screen scheme.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:issue-type-screen-scheme:jiraConnect app scope required: ADMIN
string
Requiredarray<string>
RequiredReturned if the screen scheme mappings are removed from the issue type screen scheme.
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 = `{
"issueTypeIds": [
"10000",
"10001",
"10004"
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returns a paginated list of projects associated with an issue type screen scheme.
Only company-managed projects associated with an issue type screen scheme are returned.
Permissions required: Administer Jira global permission.
manage:jira-configurationread:project:jira, read:avatar:jira, read:project-category:jiraConnect app scope required: ADMIN
integer
Requiredinteger
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/issuetypescreenscheme/{issueTypeScreenSchemeId}/project`, {
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": 100,
"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: