This resource represents the screen tabs used to record issue details. Use it to get, create, update, move, and delete screen tabs.
Returns the list of tabs for a bulk of screens.
Permissions required:
manage:jira-projectread:screen-tab:jiraConnect app scope required: ADMIN
array<integer>
array<integer>
integer
integer
Returned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/3/screens/tabs`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"isLast": true,
"maxResults": 100,
"startAt": 0,
"total": 2,
"values": [
{
"screenId": 10000,
"tabId": 10001,
"tabName": "My Custom Tab 1"
},
{
"screenId": 10001,
"tabId": 10002,
"tabName": "My Custom Tab 2"
}
]
}Returns the list of tabs for a screen.
Permissions required:
manage:jira-projectread:screen-tab:jiraConnect app scope required: ADMIN
integer
Requiredstring
Returned if the request is successful.
array<ScreenableTab>
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/3/screens/{screenId}/tabs`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
[
{
"id": 25,
"name": "<string>"
}
]Creates a tab for a screen.
Permissions required: Administer Jira global permission.
manage:jira-projectread:screen-tab:jira, write:screen-tab:jiraConnect app scope required: ADMIN
integer
Requiredstring
RequiredReturned if the request is successful.
A screen tab.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"name": "Fields Tab"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/screens/{screenId}/tabs`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
{
"id": 10000,
"name": "Fields Tab"
}Updates the name of a screen tab.
Permissions required: Administer Jira global permission.
manage:jira-projectread:screen-tab:jira, write:screen-tab:jiraConnect app scope required: ADMIN
integer
Requiredinteger
Requiredstring
RequiredReturned if the request is successful.
A screen tab.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"name": "<string>"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/screens/{screenId}/tabs/{tabId}`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
{
"id": 10000,
"name": "Fields Tab"
}Deletes a screen tab.
Permissions required: Administer Jira global permission.
manage:jira-projectdelete:screen-tab:jiraConnect app scope required: ADMIN
integer
Requiredinteger
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
10
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/3/screens/{screenId}/tabs/{tabId}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Moves a screen tab.
Permissions required: Administer Jira global permission.
manage:jira-projectwrite:screen:jiraConnect app scope required: ADMIN
integer
Requiredinteger
Requiredinteger
RequiredReturned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}`, {
method: 'POST',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Rate this page: