Class IssueNavigatorSettingsService

This resource represents issue navigator settings. Use it to get and set issue navigator default columns.

See

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

Hierarchy

CommonHttpService
- IssueNavigatorSettingsService

Index

Constructors

Methods

getIssueNavigatorDefaultColumns setIssueNavigatorDefaultColumns initialize

Constructors

constructor

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

Methods

getIssueNavigatorDefaultColumns

getIssueNavigatorDefaultColumns(): Promise<ColumnItem[]>
Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

Returns Promise<ColumnItem[]>
Returned if the request is successful.

example:
```
[
  {
    "label": "Key",
    "value": "issuekey"
  },
  {
    "label": "Summary",
    "value": "summary"
  }
]
```
Path
GET /rest/api/3/settings/columns

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-navigator-settings#api-rest-api-3-settings-columns-get

setIssueNavigatorDefaultColumns

setIssueNavigatorDefaultColumns(params): Promise<void>
Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  columnRequestBody: ColumnRequestBody;
  }
  - columnRequestBody: ColumnRequestBody
    A navigable field value.
Returns Promise<void>
Path
PUT /rest/api/3/settings/columns

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-navigator-settings#api-rest-api-3-settings-columns-put

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize