This resource represents issue type schemes in classic projects. Use it to:
Returns a paginated list of issue type schemes.
Only issue type schemes used in classic projects are returned.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationread:issue-type-scheme:jirainteger
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/2/issuetypescheme`, {
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
{
"isLast": true,
"maxResults": 100,
"startAt": 0,
"total": 3,
"values": [
{
"id": "10000",
"name": "Default Issue Type Scheme",
"description": "Default issue type scheme is the list of global issue types. All newly created issue types will automatically be added to this scheme.",
"defaultIssueTypeId": "10003",
"isDefault": true
},
{
"id": "10001",
"name": "SUP: Kanban Issue Type Scheme",
"description": "A collection of issue types suited to use in a kanban style project.",
"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
}
]
}
},
{
"id": "10002",
"name": "HR: Scrum issue type scheme",
"description": "",
"defaultIssueTypeId": "10004",
"issueTypes": {
"isLast": true,
"maxResults": 100,
"startAt": 0,
"total": 1,
"values": [
{
"description": "Improvement Issue Type",
"hierarchyLevel": -1,
"iconUrl": "www.example.com",
"id": "1000L",
"name": "Improvements",
"subtask": true
}
]
}
}
]
}Creates an issue type scheme.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:issue-type-scheme:jirastring
string
array<string>
Requiredstring
RequiredReturned if the request is successful.
The ID of an issue type 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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"defaultIssueTypeId": "10002",
"description": "A collection of issue types suited to use in a kanban style project.",
"issueTypeIds": [
"10001",
"10002",
"10003"
],
"name": "Kanban Issue Type Scheme"
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/issuetypescheme`, {
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
{
"issueTypeSchemeId": "10010"
}Returns a paginated list of issue type scheme items.
Only issue type scheme items used in classic projects are returned.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationread:issue-type-scheme:jirainteger
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/2/issuetypescheme/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
{
"isLast": true,
"maxResults": 100,
"startAt": 0,
"total": 4,
"values": [
{
"issueTypeSchemeId": "10000",
"issueTypeId": "10000"
},
{
"issueTypeSchemeId": "10000",
"issueTypeId": "10001"
},
{
"issueTypeSchemeId": "10000",
"issueTypeId": "10002"
},
{
"issueTypeSchemeId": "10001",
"issueTypeId": "10000"
}
]
}Returns a paginated list of issue type schemes and, for each issue type scheme, a list of the projects that use it.
Only issue type schemes used in classic projects are returned.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationread:issue-type-scheme:jirainteger
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/2/issuetypescheme/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
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
{
"isLast": true,
"maxResults": 100,
"startAt": 0,
"total": 3,
"values": [
{
"issueTypeScheme": {
"id": "10000",
"name": "Default Issue Type Scheme",
"description": "Default issue type scheme is the list of global issue types. All newly created issue types will automatically be added to this scheme.",
"defaultIssueTypeId": "10003",
"isDefault": true
},
"projectIds": [
"10000",
"10001"
]
},
{
"issueTypeScheme": {
"id": "10001",
"name": "SUP: Kanban Issue Type Scheme",
"description": "A collection of issue types suited to use in a kanban style project."
},
"projectIds": [
"10002"
]
},
{
"issueTypeScheme": {
"id": "10002",
"name": "HR: Scrum issue type scheme",
"description": "",
"defaultIssueTypeId": "10004",
"issueTypes": {
"isLast": true,
"maxResults": 100,
"startAt": 0,
"total": 1,
"values": [
{
"description": "Improvement Issue Type",
"hierarchyLevel": -1,
"iconUrl": "www.example.com",
"id": "1000L",
"name": "Improvements",
"subtask": true
}
]
}
},
"projectIds": [
"10003",
"10004",
"10005"
]
}
]
}Assigns an issue type scheme to a project.
If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme.
Issue type schemes can only be assigned to classic projects.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:issue-type-scheme:jira, write:project:jirastring
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
20
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"issueTypeSchemeId": "10000",
"projectId": "10000"
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/issuetypescheme/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 scheme.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:issue-type-scheme:jirainteger
Requiredstring
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
21
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"defaultIssueTypeId": "10002",
"description": "A collection of issue types suited to use in a kanban style project.",
"name": "Kanban Issue Type Scheme"
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/issuetypescheme/{issueTypeSchemeId}`, {
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 scheme.
Only issue type schemes used in classic projects can be deleted.
Any projects assigned to the scheme are reassigned to the default issue type scheme.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationdelete:issue-type-scheme:jira, write:project:jirainteger
RequiredReturned if the issue type 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/2/issuetypescheme/{issueTypeSchemeId}`, {
method: 'DELETE',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Adds issue types to an issue type scheme.
The added issue types are appended to the issue types list.
If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:issue-type-scheme:jirainteger
Requiredarray<string>
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"issueTypeIds": [
"10000",
"10002",
"10003"
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/issuetypescheme/{issueTypeSchemeId}/issuetype`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Changes the order of issue types in an issue type scheme.
The request body parameters must meet the following requirements:
after or position must be provided.after must not be in the issue type list.Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:issue-type-scheme:jirainteger
Requiredstring
array<string>
Requiredstring
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
24
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"after": "10008",
"issueTypeIds": [
"10001",
"10004",
"10002"
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/issuetypescheme/{issueTypeSchemeId}/issuetype/move`, {
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 an issue type from an issue type scheme.
This operation cannot remove:
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:issue-type-scheme:jirainteger
Requiredinteger
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/2/issuetypescheme/{issueTypeSchemeId}/issuetype/{issueTypeId}`, {
method: 'DELETE',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Rate this page: