Cloud
Jira Cloud platform / Reference / REST API v3

Issue navigator settings

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

GET

Get issue navigator default columns

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returned if the request is successful.

application/json

array<ColumnItem>

GET/rest/api/3/settings/columns
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ // // This API resource doesn't support Oauth2 (3LO). See alternate authorization methods: // https://developer.atlassian.com/cloud/jira/platform/rest/v3/#authentication import api, { route } from "@forge/api"; const response = await api.requestJira(route`/rest/api/3/settings/columns`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 [ { "label": "Key", "value": "issuekey" }, { "label": "Summary", "value": "summary" } ]
PUT

Set issue navigator default columns

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.

Data Security Policy: Exempt from app access rules
Scopes

Connect apps cannot access this REST resource.

Request

Request body*/* multipart/form-data

A navigable field value.

columns

array<string>

Responses

Returned if the request is successful.

PUT/rest/api/3/settings/columns
1 2 3 4 5 6 7 8 9 10 11 12 13 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ // // This API resource doesn't support Oauth2 (3LO). See alternate authorization methods: // https://developer.atlassian.com/cloud/jira/platform/rest/v3/#authentication import api, { route } from "@forge/api"; const response = await api.requestJira(route`/rest/api/3/settings/columns`, { method: 'PUT' }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());

Rate this page: