Class ProjectClassificationLevelsService

This resource represents classification levels used in a project. Use it to view and manage classification levels in your projects.

See

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

Hierarchy

CommonHttpService
- ProjectClassificationLevelsService

Index

Constructors

Methods

getDefaultProjectClassification removeDefaultProjectClassification updateDefaultProjectClassification initialize

Constructors

constructor

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

Methods

getDefaultProjectClassification

getDefaultProjectClassification(params): Promise<unknown>
Returns the default data classification for a project.

Permissions required:
- Browse Projects project permission for the project.
- Administer projects project permission for the project.
- Administer jira global permission.
Parameters
- params: {
  projectIdOrKey: string;
  }
  - projectIdOrKey: string
    The project ID or project key (case-sensitive).
Returns Promise<unknown>
Returned if the request is successful.

example:
```
{
  "classification": {
    "id": "ari:cloud:platform::classification-tag/5bfa70f7-4af1-44f5-9e12-1ce185f15a38",
    "status": "published",
    "name": "Restricted",
    "rank": 1,
    "description": "Data we hold that would be very damaging and would cause loss of trust with customers and present legal risk if mishandled",
    "guideline": "Access to data must be restricted to only individuals who need access in order to perform their job duties.",
    "color": "RED"
  }
}
```
Path
GET /rest/api/3/project/{projectIdOrKey}/classification-level/default @scopes-current read:jira-work @scopes-beta read:project:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-classification-levels#api-rest-api-3-project-projectidorkey-classification-level-default-get

removeDefaultProjectClassification

removeDefaultProjectClassification(params): Promise<void>
Remove the default data classification level for a project.

Permissions required:
- Administer projects project permission for the project.
- Administer jira global permission.
Parameters
- params: {
  projectIdOrKey: string;
  }
  - projectIdOrKey: string
    The project ID or project key (case-sensitive).
Returns Promise<void>
Returned if the request is successful.

Path
DELETE /rest/api/3/project/{projectIdOrKey}/classification-level/default @scopes-current manage:jira-project @scopes-beta write:project:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-classification-levels#api-rest-api-3-project-projectidorkey-classification-level-default-delete

updateDefaultProjectClassification

updateDefaultProjectClassification(params): Promise<void>
Updates the default data classification level for a project.

Permissions required:
- Administer projects project permission for the project.
- Administer jira global permission.
Parameters
- params: {
  projectIdOrKey: string;
  updateDefaultProjectClassificationBean: UpdateDefaultProjectClassificationBean;
  }
  - projectIdOrKey: string
    The project ID or project key (case-sensitive).
  - updateDefaultProjectClassificationBean: UpdateDefaultProjectClassificationBean
    Example
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/project/{projectIdOrKey}/classification-level/default @scopes-current manage:jira-project @scopes-beta write:project:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-classification-levels#api-rest-api-3-project-projectidorkey-classification-level-default-put

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize