Class PrioritySchemes

Index

Constructors

Methods

createPriorityScheme deletePriorityScheme getAvailablePrioritiesByPriorityScheme getPrioritiesByPriorityScheme getPrioritySchemes getProjectsByPriorityScheme suggestedPrioritiesForMappings updatePriorityScheme

Constructors

constructor

new PrioritySchemes(client: Client): Version3.PrioritySchemes
Parameters
- client: Client
Returns Version3.PrioritySchemes
- Defined in src/version3/prioritySchemes.ts:10

Methods

createPriorityScheme

createPriorityScheme<T = Version3Models.PrioritySchemeId>(
parameters: Version3Parameters.CreatePriorityScheme,
callback: Callback<T>,
): Promise<void>
Creates a new priority scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PrioritySchemeId
Parameters
- parameters: Version3Parameters.CreatePriorityScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/prioritySchemes.ts:62
createPriorityScheme<T = Version3Models.PrioritySchemeId>(
parameters: Version3Parameters.CreatePriorityScheme,
callback?: undefined,
): Promise<T>
Creates a new priority scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PrioritySchemeId
Parameters
- parameters: Version3Parameters.CreatePriorityScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/prioritySchemes.ts:72

deletePriorityScheme

deletePriorityScheme<T = void>(
parameters: Version3Parameters.DeletePriorityScheme,
callback: Callback<T>,
): Promise<void>
Deletes a priority scheme.

This operation is only available for priority schemes without any associated projects. Any associated projects must be removed from the priority scheme before this operation can be performed.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeletePriorityScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/prioritySchemes.ts:227
deletePriorityScheme<T = void>(
parameters: Version3Parameters.DeletePriorityScheme,
callback?: undefined,
): Promise<T>
Deletes a priority scheme.

This operation is only available for priority schemes without any associated projects. Any associated projects must be removed from the priority scheme before this operation can be performed.

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

getAvailablePrioritiesByPriorityScheme

getAvailablePrioritiesByPriorityScheme<
    T = Paginated<Version3Models.PriorityWithSequence>,
>(
    parameters: Version3Parameters.GetAvailablePrioritiesByPriorityScheme,
    callback: Callback<T>,
): Promise<void>
Returns a paginated list of priorities available for adding to a priority scheme.

Permissions required: Permission to access Jira.
Type Parameters
- T = Paginated<Version3Models.PriorityWithSequence>
Parameters
- parameters: Version3Parameters.GetAvailablePrioritiesByPriorityScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/prioritySchemes.ts:144
getAvailablePrioritiesByPriorityScheme<
    T = Paginated<Version3Models.PriorityWithSequence>,
>(
    parameters: Version3Parameters.GetAvailablePrioritiesByPriorityScheme,
    callback?: undefined,
): Promise<T>
Returns a paginated list of priorities available for adding to a priority scheme.

Permissions required: Permission to access Jira.
Type Parameters
- T = Paginated<Version3Models.PriorityWithSequence>
Parameters
- parameters: Version3Parameters.GetAvailablePrioritiesByPriorityScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/prioritySchemes.ts:155

getPrioritiesByPriorityScheme

getPrioritiesByPriorityScheme<
    T = Paginated<Version3Models.PriorityWithSequence>,
>(
    parameters: Version3Parameters.GetPrioritiesByPriorityScheme,
    callback: Callback<T>,
): Promise<void>
Returns a paginated list of priorities by scheme.

Permissions required: Permission to access Jira.
Type Parameters
- T = Paginated<Version3Models.PriorityWithSequence>
Parameters
- parameters: Version3Parameters.GetPrioritiesByPriorityScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/prioritySchemes.ts:260
getPrioritiesByPriorityScheme<
    T = Paginated<Version3Models.PriorityWithSequence>,
>(
    parameters: Version3Parameters.GetPrioritiesByPriorityScheme,
    callback?: undefined,
): Promise<T>
Returns a paginated list of priorities by scheme.

Permissions required: Permission to access Jira.
Type Parameters
- T = Paginated<Version3Models.PriorityWithSequence>
Parameters
- parameters: Version3Parameters.GetPrioritiesByPriorityScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/prioritySchemes.ts:271

getPrioritySchemes

getPrioritySchemes<
    T = Paginated<
        Version3Models.PrioritySchemeWithPaginatedPrioritiesAndProjects,
    >,
>(
    parameters: undefined | Version3Parameters.GetPrioritySchemes,
    callback: Callback<T>,
): Promise<void>
Returns a paginated list of priority schemes.

Permissions required: Permission to access Jira.
Type Parameters
- T = Paginated<Version3Models.PrioritySchemeWithPaginatedPrioritiesAndProjects>
Parameters
- parameters: undefined | Version3Parameters.GetPrioritySchemes
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/prioritySchemes.ts:19
getPrioritySchemes<
    T = Paginated<
        Version3Models.PrioritySchemeWithPaginatedPrioritiesAndProjects,
    >,
>(
    parameters?: Version3Parameters.GetPrioritySchemes,
    callback?: undefined,
): Promise<T>
Returns a paginated list of priority schemes.

Permissions required: Permission to access Jira.
Type Parameters
- T = Paginated<Version3Models.PrioritySchemeWithPaginatedPrioritiesAndProjects>
Parameters
- Optionalparameters: Version3Parameters.GetPrioritySchemes
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/prioritySchemes.ts:30

getProjectsByPriorityScheme

getProjectsByPriorityScheme<T = Version3Models.PageProject>(
parameters: Version3Parameters.GetProjectsByPriorityScheme,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of projects by scheme.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.PageProject
Parameters
- parameters: Version3Parameters.GetProjectsByPriorityScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/prioritySchemes.ts:298
getProjectsByPriorityScheme<T = Version3Models.PageProject>(
parameters: Version3Parameters.GetProjectsByPriorityScheme,
callback?: undefined,
): Promise<T>
Returns a paginated list of projects by scheme.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.PageProject
Parameters
- parameters: Version3Parameters.GetProjectsByPriorityScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/prioritySchemes.ts:309

suggestedPrioritiesForMappings

suggestedPrioritiesForMappings<
    T = Paginated<Version3Models.PriorityWithSequence>,
>(
    parameters:
        | undefined
        | Version3Parameters.SuggestedPrioritiesForMappings,
    callback: Callback<T>,
): Promise<void>
Returns a paginated list of priorities that would require mapping, given a change in priorities or projects associated with a priority scheme.

Permissions required: Permission to access Jira.
Type Parameters
- T = Paginated<Version3Models.PriorityWithSequence>
Parameters
- parameters: undefined | Version3Parameters.SuggestedPrioritiesForMappings
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/prioritySchemes.ts:103
suggestedPrioritiesForMappings<
    T = Paginated<Version3Models.PriorityWithSequence>,
>(
    parameters?: Version3Parameters.SuggestedPrioritiesForMappings,
    callback?: undefined,
): Promise<T>
Returns a paginated list of priorities that would require mapping, given a change in priorities or projects associated with a priority scheme.

Permissions required: Permission to access Jira.
Type Parameters
- T = Paginated<Version3Models.PriorityWithSequence>
Parameters
- Optionalparameters: Version3Parameters.SuggestedPrioritiesForMappings
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/prioritySchemes.ts:114

updatePriorityScheme

updatePriorityScheme<T = Version3Models.UpdatePrioritySchemeResponse>(
parameters: Version3Parameters.UpdatePriorityScheme,
callback: Callback<T>,
): Promise<void>
Updates a priority scheme. This includes its details, the lists of priorities and projects in it

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.UpdatePrioritySchemeResponse
Parameters
- parameters: Version3Parameters.UpdatePriorityScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/prioritySchemes.ts:184
updatePriorityScheme<T = Version3Models.UpdatePrioritySchemeResponse>(
parameters: Version3Parameters.UpdatePriorityScheme,
callback?: undefined,
): Promise<T>
Updates a priority scheme. This includes its details, the lists of priorities and projects in it

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.UpdatePrioritySchemeResponse
Parameters
- parameters: Version3Parameters.UpdatePriorityScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/prioritySchemes.ts:194

Class PrioritySchemes

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.PrioritySchemes

Methods

createPriorityScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deletePriorityScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAvailablePrioritiesByPriorityScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getPrioritiesByPriorityScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getPrioritySchemes

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getProjectsByPriorityScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

suggestedPrioritiesForMappings

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updatePriorityScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page