Class IssuePriorities

Index

Constructors

Methods

createPriority deletePriority getPriorities getPriority movePriorities searchPriorities setDefaultPriority updatePriority

Constructors

constructor

new IssuePriorities(client: Client): Version3.IssuePriorities
Parameters
- client: Client
Returns Version3.IssuePriorities
- Defined in src/version3/issuePriorities.ts:9

Methods

createPriority

createPriority<T = Version3Models.PriorityId>(
parameters: Version3Parameters.CreatePriority,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.PriorityId
Parameters
- parameters: Version3Parameters.CreatePriority
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issuePriorities.ts:43
createPriority<T = Version3Models.PriorityId>(
parameters: Version3Parameters.CreatePriority,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.PriorityId
Parameters
- parameters: Version3Parameters.CreatePriority
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issuePriorities.ts:56

deletePriority

deletePriority<T = unknown>(
parameters: Version3Parameters.DeletePriority,
callback: Callback<T>,
): 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.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.DeletePriority
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issuePriorities.ts:268
deletePriority<T = unknown>(
parameters: Version3Parameters.DeletePriority,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.DeletePriority
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issuePriorities.ts:280

getPriorities

getPriorities<T = Version3Models.Priority[]>(
callback: Callback<T>,
): Promise<void>
Returns the list of all issue priorities.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.Priority[]
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issuePriorities.ts:17
getPriorities<T = Version3Models.Priority[]>(callback?: undefined): Promise<T>
Returns the list of all issue priorities.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.Priority[]
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issuePriorities.ts:24

getPriority

getPriority<T = Version3Models.Priority>(
parameters: Version3Parameters.GetPriority,
callback: Callback<T>,
): Promise<void>
Returns an issue priority.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.Priority
Parameters
- parameters: Version3Parameters.GetPriority
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issuePriorities.ts:197
getPriority<T = Version3Models.Priority>(
parameters: Version3Parameters.GetPriority,
callback?: undefined,
): Promise<T>
Returns an issue priority.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.Priority
Parameters
- parameters: Version3Parameters.GetPriority
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issuePriorities.ts:204

movePriorities

movePriorities<T = void>(
parameters: Version3Parameters.MovePriorities,
callback: Callback<T>,
): Promise<void>
Changes the order of issue priorities.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.MovePriorities
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issuePriorities.ts:114
movePriorities<T = void>(
parameters: Version3Parameters.MovePriorities,
callback?: undefined,
): Promise<T>
Changes the order of issue priorities.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.MovePriorities
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issuePriorities.ts:121

searchPriorities

searchPriorities<T = Version3Models.PagePriority>(
parameters: undefined | Version3Parameters.SearchPriorities,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.PagePriority
Parameters
- parameters: undefined | Version3Parameters.SearchPriorities
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issuePriorities.ts:149
searchPriorities<T = Version3Models.PagePriority>(
parameters?: Version3Parameters.SearchPriorities,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.PagePriority
Parameters
- Optionalparameters: Version3Parameters.SearchPriorities
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issuePriorities.ts:166

setDefaultPriority

setDefaultPriority<T = void>(
parameters: undefined | Version3Parameters.SetDefaultPriority,
callback: Callback<T>,
): Promise<void>
Sets default issue priority.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: undefined | Version3Parameters.SetDefaultPriority
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issuePriorities.ts:82
setDefaultPriority<T = void>(
parameters?: Version3Parameters.SetDefaultPriority,
callback?: undefined,
): Promise<T>
Sets default issue priority.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- Optionalparameters: Version3Parameters.SetDefaultPriority
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issuePriorities.ts:92

updatePriority

updatePriority<T = void>(
parameters: Version3Parameters.UpdatePriority,
callback: Callback<T>,
): 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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdatePriority
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issuePriorities.ts:228
updatePriority<T = void>(
parameters: Version3Parameters.UpdatePriority,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdatePriority
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issuePriorities.ts:240

Class IssuePriorities

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.IssuePriorities

Methods

createPriority

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deletePriority

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getPriorities

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getPriority

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

movePriorities

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

searchPriorities

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

setDefaultPriority

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updatePriority

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page