This resource represents the screens used to record issue details. Use it to:
Returns a paginated list of the screens a field is used in.
Permissions required: Administer Jira global permission.
Connect app scope required: NONE
manage:jira-projectread:screen:jira, read:avatar:jira, read:project-category:jira, read:project:jira, read:screen-tab:jirastring
Requiredinteger
integer
string
Returned if the request is successful.
A page of items.
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/2/field/{fieldId}/screens`, {
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
{
"isLast": false,
"maxResults": 1,
"startAt": 0,
"total": 5,
"values": [
{
"id": 10001,
"name": "Default Screen",
"description": "Provides for the update of all system fields.",
"tab": {
"id": 10000,
"name": "Fields Tab"
}
}
]
}Returns a paginated list of all screens or those specified by one or more screen IDs.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-projectread:project:jira, read:screen:jira, read:avatar:jira, read:project-category:jirainteger
integer
array<integer>
string
array<string>
string
Returned if the request is successful.
A page of items.
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/2/screens`, {
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
19
20
21
22
23
24
{
"isLast": true,
"maxResults": 100,
"self": "https://your-domain.atlassian.net/rest/api/2/screens",
"startAt": 0,
"total": 3,
"values": [
{
"id": 1,
"name": "Default Screen",
"description": "Provides for the update all system fields."
},
{
"id": 2,
"name": "Workflow Screen",
"description": "This screen is used in the workflow and enables you to assign issues."
},
{
"id": 3,
"name": "Resolve Issue Screen",
"description": "Offers the ability to set resolution, change fix versions, and assign an issue."
}
]
}Creates a screen with a default field tab.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-projectread:project:jira, read:screen:jira, write:screen:jira, read:avatar:jira, read:project-category:jirastring
string
RequiredReturned if the request is successful.
A screen.
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 = `{
"description": "Enables changes to resolution and linked issues.",
"name": "Resolve Security Issue Screen"
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/screens`, {
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
5
{
"id": 10005,
"name": "Resolve Security Issue Screen",
"description": "Enables changes to resolution and linked issues."
}Adds a field to the default tab of the default screen.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-projectread:project:jira, read:screen:jira, write:screen:jirastring
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/2/screens/addToDefault/{fieldId}`, {
method: 'POST',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Updates a screen. Only screens used in classic projects can be updated.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-projectread:project:jira, read:screen:jira, write:screen:jira, read:avatar:jira, read:project-category:jirainteger
Requiredstring
string
Returned if the request is successful.
A screen.
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 = `{
"description": "Enables changes to resolution and linked issues for accessibility related issues.",
"name": "Resolve Accessibility Issue Screen"
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/screens/{screenId}`, {
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
5
{
"id": 10005,
"name": "Resolve Security Issue Screen",
"description": "Enables changes to resolution and linked issues."
}Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft. Only screens used in classic projects can be deleted.
Connect app scope required: ADMIN
manage:jira-projectdelete:screen:jirainteger
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/2/screens/{screenId}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returns the fields that can be added to a tab on a screen.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-projectread:screen-field:jira, read:screenable-field:jirainteger
RequiredReturned 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/2/screens/{screenId}/availableFields`, {
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>"
}
]Rate this page: