This resource represents issues types. Use it to:
Returns all issue types.
This operation can be accessed anonymously.
Permissions required: Issue types are only returned as follows:
Connect app scope required: READ
read:jira-workread:issue-type:jira, read:avatar:jira, read:project-category:jira, read:project:jiraThis request has no parameters.
Returned if the request is successful.
array<IssueTypeDetails>
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/issuetype`, {
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
[
{
"avatarId": 1,
"description": "A task that needs to be done.",
"hierarchyLevel": 0,
"iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
"id": "3",
"name": "Task",
"self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
"subtask": false
},
{
"avatarId": 10002,
"description": "A problem with the software.",
"entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
"hierarchyLevel": 0,
"iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
"id": "1",
"name": "Bug",
"scope": {
"project": {
"id": "10000"
},
"type": "PROJECT"
},
"self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
"subtask": false
}
]Creates an issue type and adds it to the default issue type scheme.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:issue-type:jira, read:avatar:jira, read:issue-type:jira, read:project-category:jira, read:project:jirastring
integer
string
Requiredstring
Returned if the request is successful.
Details about an issue type.
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 = `{
"description": "description",
"name": "name",
"type": "standard"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/issuetype`, {
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
{
"avatarId": 34,
"description": "<string>",
"entityId": "<string>",
"hierarchyLevel": 34,
"iconUrl": "<string>",
"id": "<string>",
"name": "<string>",
"scope": {
"project": {
"avatarUrls": {},
"id": "<string>",
"key": "<string>",
"name": "<string>",
"projectCategory": {},
"projectTypeKey": "software",
"self": "<string>",
"simplified": true
},
"type": "PROJECT"
},
"self": "<string>",
"subtask": true
}Returns issue types for a project.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission in the relevant project or Administer Jira global permission.
Connect app scope required: READ
read:jira-workread:issue-type:jira, read:avatar:jira, read:project-category:jira, read:project:jirainteger
Requiredinteger
Returned if the request is successful.
array<IssueTypeDetails>
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/issuetype/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
[
{
"avatarId": 10002,
"description": "A problem with the software.",
"entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
"hierarchyLevel": 0,
"iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
"id": "1",
"name": "Bug",
"scope": {
"project": {
"id": "10000"
},
"type": "PROJECT"
},
"self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
"subtask": false
},
{
"avatarId": 1,
"description": "A task that needs to be done.",
"hierarchyLevel": 0,
"iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
"id": "3",
"name": "Task",
"scope": {
"project": {
"id": "10000"
},
"type": "PROJECT"
},
"self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
"subtask": false
}
]Returns an issue type.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission in a project the issue type is associated with or Administer Jira global permission.
Connect app scope required: READ
read:jira-workread:issue-type:jira, read:avatar:jira, read:project-category:jira, read:project:jirastring
RequiredReturned if the request is successful.
Details about an issue type.
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/issuetype/{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
{
"avatarId": 1,
"description": "A task that needs to be done.",
"hierarchyLevel": 0,
"iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
"id": "3",
"name": "Task",
"self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
"subtask": false
}Updates the issue type.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:issue-type:jira, read:avatar:jira, read:issue-type:jira, read:project-category:jira, read:project:jirastring
Requiredinteger
string
string
Returned if the request is successful.
Details about an issue type.
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 = `{
"avatarId": 1,
"description": "description",
"name": "name"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/issuetype/{id}`, {
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
{
"avatarId": 34,
"description": "<string>",
"entityId": "<string>",
"hierarchyLevel": 34,
"iconUrl": "<string>",
"id": "<string>",
"name": "<string>",
"scope": {
"project": {
"avatarUrls": {},
"id": "<string>",
"key": "<string>",
"name": "<string>",
"projectCategory": {},
"projectTypeKey": "software",
"self": "<string>",
"simplified": true
},
"type": "PROJECT"
},
"self": "<string>",
"subtask": true
}Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (alternativeIssueTypeId). A list of alternative issue types are obtained from the Get alternative issue types resource.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationdelete:issue-type:jirastring
Requiredstring
Returned if the request is successful.
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/issuetype/{id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.
This operation can be accessed anonymously.
Permissions required: None.
Connect app scope required: READ
read:jira-workread:issue-type:jira, read:project-category:jira, read:project:jira, read:avatar:jirastring
RequiredReturned if the request is successful.
array<IssueTypeDetails>
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/issuetype/{id}/alternatives`, {
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
[
{
"avatarId": 1,
"description": "A task that needs to be done.",
"hierarchyLevel": 0,
"iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
"id": "3",
"name": "Task",
"self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
"subtask": false
},
{
"avatarId": 10002,
"description": "A problem with the software.",
"entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
"hierarchyLevel": 0,
"iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
"id": "1",
"name": "Bug",
"scope": {
"project": {
"id": "10000"
},
"type": "PROJECT"
},
"self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
"subtask": false
}
]Loads an avatar for the issue type.
Specify the avatar's local file location in the body of the request. Also, include the following headers:
X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.Content-Type: image/image type Valid image types are JPEG, GIF, or PNG.For example:
curl --request POST \ --user email@example.com:<api_token> \ --header 'X-Atlassian-Token: no-check' \ --header 'Content-Type: image/< image_type>' \ --data-binary "<@/path/to/file/with/your/avatar>" \ --url 'https://your-domain.atlassian.net/rest/api/3/issuetype/{issueTypeId}'This
The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.
The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.
After creating the avatar, use Update issue type to set it as the issue type's displayed avatar.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:avatar:jira, write:issue-type:jira, read:avatar:jirastring
Requiredinteger
integer
integer
Requiredany
Returned if the request is successful.
Details of an avatar.
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/issuetype/{id}/avatar2?size={size}`, {
method: 'POST',
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
{
"id": "1000",
"isDeletable": false,
"isSelected": false,
"isSystemAvatar": true,
"urls": {
"16x16": "/secure/useravatar?size=xsmall&avatarId=10040&avatarType=project",
"24x24": "/secure/useravatar?size=small&avatarId=10040&avatarType=project",
"32x32": "/secure/useravatar?size=medium&avatarId=10040&avatarType=project",
"48x48": "/secure/useravatar?avatarId=10040&avatarType=project"
}
}Rate this page: