This resource represents project categories. Use it to create, update, and delete project categories as well as obtain a list of all project categories and details of individual categories. For more information on managing project categories, see Adding, assigning, and deleting project categories.
Returns all project categories.
Permissions required: Permission to access Jira.
read:jira-workread:project-category:jiraConnect app scope required: READ
This request has no parameters.
Returned if the request is successful.
array<ProjectCategory>
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/projectCategory`, {
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
[
{
"description": "First Project Category",
"id": "10000",
"name": "FIRST",
"self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
},
{
"description": "Second Project Category",
"id": "10001",
"name": "SECOND",
"self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10001"
}
]Creates a project category.
Permissions required: Administer Jira global permission.
manage:jira-projectwrite:project-category:jira, read:project-category:jiraConnect app scope required: ADMIN
string
string
Returned if the request is successful.
A project category.
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": "Created Project Category",
"name": "CREATED"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/projectCategory`, {
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
{
"description": "Created Project Category",
"id": "10100",
"name": "CREATED",
"self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10100"
}Returns a project category.
Permissions required: Permission to access Jira.
read:jira-workread:project-category:jiraConnect app scope required: READ
integer
RequiredReturned if the request is successful.
A project category.
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/projectCategory/{id}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
{
"description": "First Project Category",
"id": "10000",
"name": "FIRST",
"self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
}Updates a project category.
Permissions required: Administer Jira global permission.
manage:jira-projectread:project-category:jira, write:project-category:jiraConnect app scope required: ADMIN
integer
Requiredstring
string
Returned if the request is successful.
A project category.
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": "Updated Project Category",
"name": "UPDATED"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/projectCategory/{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
{
"description": "Updated Project Category",
"id": "10100",
"name": "UPDATED",
"self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10100"
}Deletes a project category.
Permissions required: Administer Jira global permission.
manage:jira-projectdelete:project-category:jiraConnect app scope required: ADMIN
integer
RequiredReturned 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/projectCategory/{id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Rate this page: