Class IssuePrioritiesService

This resource represents issue priorities. Use it to get, create and update issue priorities and details for individual issue priorities.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities

Hierarchy

CommonHttpService
- IssuePrioritiesService

Index

Constructors

constructor

Methods

createPriority deletePriority getPriorities getPriority movePriorities searchPriorities setDefaultPriority updatePriority initialize

Constructors

constructor

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

Methods

createPriority

createPriority(params): Promise<PriorityId>
Creates an issue priority.

Deprecation applies to iconUrl param in request body which will be sunset on 16th Mar 2025. For more details refer to changelog.

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

example:
```
{
  "id": "10001"
}
```
Deprecated
Path
POST /rest/api/3/priority

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities#api-rest-api-3-priority-post

deletePriority

deletePriority(params): Promise<void>
Deletes an issue priority.

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: string;
  }
  - id: string
    The ID of the issue priority.
Returns Promise<void>
Path
DELETE /rest/api/3/priority/{id}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities#api-rest-api-3-priority-id-delete

getPriorities

getPriorities(): Promise<Priority[]>

Returns the list of all issue priorities.

Permissions required: Permission to access Jira.

Returns Promise<Priority[]>

Returned if the request is successful.

example:

[
  {
    "description": "Major loss of function.",
    "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/major.png",
    "id": "1",
    "name": "Major",
    "self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
    "statusColor": "#009900"
  },
  {
    "description": "Very little impact.",
    "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/trivial.png",
    "id": "2",
    "name": "Trivial",
    "self": "https://your-domain.atlassian.net/rest/api/3/priority/5",
    "statusColor": "#cfcfcf"
  }
]

Deprecated

Path

GET /rest/api/3/priority @scopes-current read:jira-work @scopes-beta read:priority:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities#api-rest-api-3-priority-get

getPriority

getPriority(params): Promise<Priority>
Returns an issue priority.

Permissions required: Permission to access Jira.
Parameters
- params: {
  id: string;
  }
  - id: string
    The ID of the issue priority.
Returns Promise<Priority>
Returned if the request is successful.

example:
```
{
  "description": "Major loss of function.",
  "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/major.png",
  "id": "1",
  "name": "Major",
  "self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
  "statusColor": "#009900"
}
```
Path
GET /rest/api/3/priority/{id} @scopes-current read:jira-work @scopes-beta read:priority:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities#api-rest-api-3-priority-id-get

movePriorities

movePriorities(params): Promise<void>
Changes the order of issue priorities.

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

Path
PUT /rest/api/3/priority/move

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities#api-rest-api-3-priority-move-put

searchPriorities

searchPriorities(params?): Promise<PageBeanPriority>
Returns a paginated list of priorities. The list can contain all priorities or a subset determined by any combination of these criteria:
- a list of priority IDs. Any invalid priority IDs are ignored.
- a list of project IDs. Only priorities that are available in these projects will be returned. Any invalid project IDs are ignored.
- whether the field configuration is a default. This returns priorities from company-managed (classic) projects only, as there is no concept of default priorities in team-managed projects.
Permissions required: Permission to access Jira.
Parameters
- params: {
      expand?: string;
      id?: string[];
      maxResults?: string;
      onlyDefault?: boolean;
      priorityName?: string;
      projectId?: string[];
      startAt?: string;
  } = {}
  - Optionalexpand?: string
    Use schemes to return the associated priority schemes for each priority. Limited to returning first 15 priority schemes per priority.
  - Optionalid?: string[]
    The list of priority IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=2&id=3.
  - OptionalmaxResults?: string
    The maximum number of items to return per page.
  - OptionalonlyDefault?: boolean
    Whether only the default priority is returned.
  - OptionalpriorityName?: string
    The name of priority to search for.
  - OptionalprojectId?: string[]
    The list of projects IDs. To include multiple IDs, provide an ampersand-separated list. For example, projectId=10010&projectId=10111.
  - OptionalstartAt?: string
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanPriority>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 50,
  "startAt": 0,
  "total": 2,
  "values": [
    {
      "description": "Major loss of function.",
      "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/major.png",
      "id": "1",
      "isDefault": true,
      "name": "Major",
      "self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
      "statusColor": "#009900"
    },
    {
      "description": "Very little impact.",
      "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/trivial.png",
      "id": "2",
      "isDefault": false,
      "name": "Trivial",
      "self": "https://your-domain.atlassian.net/rest/api/3/priority/5",
      "statusColor": "#cfcfcf"
    }
  ]
}
```
Deprecated
Path
GET /rest/api/3/priority/search

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities#api-rest-api-3-priority-search-get

setDefaultPriority

setDefaultPriority(params): Promise<void>
Sets default issue priority.

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

Path
PUT /rest/api/3/priority/default

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities#api-rest-api-3-priority-default-put

updatePriority

updatePriority(params): Promise<void>
Updates an issue priority.

At least one request body parameter must be defined.

Deprecation applies to iconUrl param in request body which will be sunset on 16th Mar 2025. For more details refer to changelog.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: string;
  updatePriorityDetails: UpdatePriorityDetails;
  }
  - id: string
    The ID of the issue priority.
  - updatePriorityDetails: UpdatePriorityDetails
    Example
Returns Promise<void>
Returned if the request is successful.

Deprecated
Path
PUT /rest/api/3/priority/{id}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities#api-rest-api-3-priority-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 IssuePrioritiesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssuePrioritiesService

Methods

createPriority

Parameters

createPriorityDetails: CreatePriorityDetails

Example

Returns Promise<PriorityId>

Deprecated

Path

See

deletePriority

Parameters

id: string

Returns Promise<void>

Path

See

getPriorities

Returns Promise<Priority[]>

Deprecated

Path

See

getPriority

Parameters

id: string

Returns Promise<Priority>

Path

See

movePriorities

Parameters

reorderIssuePriorities: ReorderIssuePriorities

Example

Returns Promise<void>

Path

See

searchPriorities

Parameters

Optionalexpand?: string

Optionalid?: string[]

OptionalmaxResults?: string

OptionalonlyDefault?: boolean

OptionalpriorityName?: string

OptionalprojectId?: string[]

OptionalstartAt?: string

Returns Promise<PageBeanPriority>

Deprecated

Path

See

setDefaultPriority

Parameters

setDefaultPriorityRequest: SetDefaultPriorityRequest

Example

Returns Promise<void>

Path

See

updatePriority

Parameters

id: string

updatePriorityDetails: UpdatePriorityDetails

Example

Returns Promise<void>

Deprecated

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`expand?: string

`Optional`id?: string[]

`Optional`maxResults?: string

`Optional`onlyDefault?: boolean

`Optional`priorityName?: string

`Optional`projectId?: string[]

`Optional`startAt?: string

`Protected` `Static`initialize