Class IssueResolutionsService

This resource represents issue resolution values. Use it to obtain a list of all issue resolution values and the details of individual resolution values.

See

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

Hierarchy

CommonHttpService
- IssueResolutionsService

Index

Constructors

constructor

Methods

createResolution deleteResolution getResolution getResolutions moveResolutions searchResolutions setDefaultResolution updateResolution initialize

Constructors

constructor

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

Methods

createResolution

createResolution(params): Promise<ResolutionId>
Creates an issue resolution.

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

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

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

deleteResolution

deleteResolution(params): Promise<void>
Deletes an issue resolution.

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;
  replaceWith: string;
  }
  - id: string
    The ID of the issue resolution.
  - replaceWith: string
    The ID of the issue resolution that will replace the currently selected resolution.
Returns Promise<void>
Path
DELETE /rest/api/3/resolution/{id}

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

getResolution

getResolution(params): Promise<Resolution>
Returns an issue resolution value.

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

example:
```
{
  "description": "A fix for this issue is checked into the tree and tested.",
  "id": "10000",
  "name": "Fixed",
  "self": "https://your-domain.atlassian.net/rest/api/3/resolution/1"
}
```
Path
GET /rest/api/3/resolution/{id} @scopes-current read:jira-work @scopes-beta read:resolution:jira

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

getResolutions

getResolutions(): Promise<Resolution[]>

Returns a list of all issue resolution values.

Permissions required: Permission to access Jira.

Returns Promise<Resolution[]>

Returned if the request is successful.

example:

[
  {
    "description": "A fix for this issue is checked into the tree and tested.",
    "id": "10000",
    "name": "Fixed",
    "self": "https://your-domain.atlassian.net/rest/api/3/resolution/1"
  },
  {
    "description": "This is what it is supposed to do.",
    "id": "10001",
    "name": "Works as designed",
    "self": "https://your-domain.atlassian.net/rest/api/3/resolution/3"
  }
]

Deprecated

Path

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

See

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

moveResolutions

moveResolutions(params): Promise<void>
Changes the order of issue resolutions.

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

Path
PUT /rest/api/3/resolution/move

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

searchResolutions

searchResolutions(params?): Promise<PageBeanResolutionJsonBean>
Returns a paginated list of resolutions. The list can contain all resolutions or a subset determined by any combination of these criteria:
- a list of resolutions IDs.
- whether the field configuration is a default. This returns resolutions from company-managed (classic) projects only, as there is no concept of default resolutions in team-managed projects.
Permissions required: Permission to access Jira.
Parameters
- params: {
      id?: string[];
      maxResults?: string;
      onlyDefault?: boolean;
      startAt?: string;
  } = {}
  - Optionalid?: string[]
    The list of resolutions IDs to be filtered out
  - OptionalmaxResults?: string
    The maximum number of items to return per page.
  - OptionalonlyDefault?: boolean
    When set to true, return default only, when IDs provided, if none of them is default, return empty page. Default value is false
  - OptionalstartAt?: string
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanResolutionJsonBean>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 50,
  "startAt": 0,
  "total": 1,
  "values": [
    {
      "description": "This is what it is supposed to do.",
      "id": "10001",
      "isDefault": true,
      "name": "Works as designed"
    }
  ]
}
```
Path
GET /rest/api/3/resolution/search @scopes-current read:jira-work @scopes-beta read:resolution:jira

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

setDefaultResolution

setDefaultResolution(params): Promise<void>
Sets default issue resolution.

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

Path
PUT /rest/api/3/resolution/default

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

updateResolution

updateResolution(params): Promise<void>
Updates an issue resolution.

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

Path
PUT /rest/api/3/resolution/{id}

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

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueResolutionsService

Methods

createResolution

Parameters

createResolutionDetails: CreateResolutionDetails

Example

Returns Promise<ResolutionId>

Path

See

deleteResolution

Parameters

id: string

replaceWith: string

Returns Promise<void>

Path

See

getResolution

Parameters

id: string

Returns Promise<Resolution>

Path

See

getResolutions

Returns Promise<Resolution[]>

Deprecated

Path

See

moveResolutions

Parameters

reorderIssueResolutionsRequest: ReorderIssueResolutionsRequest

Example

Returns Promise<void>

Path

See

searchResolutions

Parameters

Optionalid?: string[]

OptionalmaxResults?: string

OptionalonlyDefault?: boolean

OptionalstartAt?: string

Returns Promise<PageBeanResolutionJsonBean>

Path

See

setDefaultResolution

Parameters

setDefaultResolutionRequest: SetDefaultResolutionRequest

Example

Returns Promise<void>

Path

See

updateResolution

Parameters

id: string

updateResolutionDetails: UpdateResolutionDetails

Example

Returns Promise<void>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`id?: string[]

`Optional`maxResults?: string

`Optional`onlyDefault?: boolean

`Optional`startAt?: string

`Protected` `Static`initialize