Class ProjectCategoriesService

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.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories

Hierarchy

CommonHttpService
- ProjectCategoriesService

Index

Constructors

constructor

Methods

createProjectCategory getAllProjectCategories getProjectCategoryById removeProjectCategory updateProjectCategory initialize

Constructors

constructor

new ProjectCategoriesService(getClientInstance): ProjectCategoriesService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns ProjectCategoriesService
Inherited from CommonHttpService.constructor

Methods

createProjectCategory

createProjectCategory(params): Promise<ProjectCategory>
Creates a project category.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  projectCategory: ProjectCategory;
  }
  - projectCategory: ProjectCategory
    Example
Returns Promise<ProjectCategory>
Returned if the request is successful.

example:
```
{
  "description": "Created Project Category",
  "id": "10100",
  "name": "CREATED",
  "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10100"
}
```
Path
POST /rest/api/3/projectCategory @scopes-current manage:jira-project @scopes-beta write:project-category:jira, read:project-category:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories#api-rest-api-3-projectcategory-post

getAllProjectCategories

getAllProjectCategories(): Promise<ProjectCategory[]>

Returns all project categories.

Permissions required: Permission to access Jira.

Returns Promise<ProjectCategory[]>

Returned if the request is successful.

example:

[
  {
    "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"
  }
]

Path

GET /rest/api/3/projectCategory @scopes-current read:jira-work @scopes-beta read:project-category:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories#api-rest-api-3-projectcategory-get

getProjectCategoryById

getProjectCategoryById(params): Promise<ProjectCategory>
Returns a project category.

Permissions required: Permission to access Jira.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the project category.
Returns Promise<ProjectCategory>
Returned if the request is successful.

example:
```
{
  "description": "First Project Category",
  "id": "10000",
  "name": "FIRST",
  "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
}
```
Path
GET /rest/api/3/projectCategory/{id} @scopes-current read:jira-work @scopes-beta read:project-category:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories#api-rest-api-3-projectcategory-id-get

removeProjectCategory

removeProjectCategory(params): Promise<void>
Deletes a project category.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: number;
  }
  - id: number
    ID of the project category to delete.
Returns Promise<void>
Path
DELETE /rest/api/3/projectCategory/{id} @scopes-current manage:jira-project @scopes-beta delete:project-category:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories#api-rest-api-3-projectcategory-id-delete

updateProjectCategory

updateProjectCategory(params): Promise<UpdatedProjectCategory>
Updates a project category.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: number;
  projectCategory: ProjectCategory;
  }
  - id: number
  - projectCategory: ProjectCategory
    Example
Returns Promise<UpdatedProjectCategory>
Returned if the request is successful.

example:
```
{
  "description": "Updated Project Category",
  "id": "10100",
  "name": "UPDATED",
  "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10100"
}
```
Path
PUT /rest/api/3/projectCategory/{id} @scopes-current manage:jira-project @scopes-beta read:project-category:jira, write:project-category:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories#api-rest-api-3-projectcategory-id-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class ProjectCategoriesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns ProjectCategoriesService

Methods

createProjectCategory

Parameters

projectCategory: ProjectCategory

Example

Returns Promise<ProjectCategory>

Path

See

getAllProjectCategories

Returns Promise<ProjectCategory[]>

Path

See

getProjectCategoryById

Parameters

id: number

Returns Promise<ProjectCategory>

Path

See

removeProjectCategory

Parameters

id: number

Returns Promise<void>

Path

See

updateProjectCategory

Parameters

id: number

projectCategory: ProjectCategory

Example

Returns Promise<UpdatedProjectCategory>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Protected` `Static`initialize