This resource represents the screen tab fields used to record issue details. Use it to get, add, move, and remove fields from screen tabs.
Returns all fields for a screen tab.
Permissions required:
manage:jira-projectread:screenable-field:jiraConnect app scope required: ADMIN
integer
Requiredinteger
Requiredstring
Returned if the request is successful.
array<ScreenableField>
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/{tabId}/fields`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
[
{
"id": "<string>",
"name": "<string>"
}
]Adds a field to a screen tab.
Permissions required: Administer Jira global permission.
manage:jira-projectread:screenable-field:jira, write:screenable-field:jiraConnect app scope required: ADMIN
integer
Requiredinteger
Requiredstring
RequiredReturned if the request is successful.
A screen tab field.
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 = `{
"fieldId": "summary"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/screens/{screenId}/tabs/{tabId}/fields`, {
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": "summary",
"name": "Summary"
}Removes a field from a screen tab.
Permissions required: Administer Jira global permission.
manage:jira-projectdelete:screenable-field:jiraConnect app scope required: ADMIN
integer
Requiredinteger
Requiredstring
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}/fields/{id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Moves a screen tab field.
If after and position are provided in the request, position is ignored.
Permissions required: Administer Jira global permission.
manage:jira-projectwrite:screenable-field:jiraConnect app scope required: ADMIN
integer
Requiredinteger
Requiredstring
Requiredstring
string
Returned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"after": "<string>",
"position": "Earlier"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Rate this page: