• Announcement banner
  • App data policies (EAP)
  • Application roles
  • Audit records
  • Avatars
  • Classification levels
  • Dashboards
  • Filters
  • Filter sharing
  • Group and user picker
  • Groups
  • Issues
  • UI modifications (apps)
  • Issue attachments
  • Issue comments
  • Issue comment properties
  • Issue fields
  • Issue field configurations
  • Issue custom field contexts
  • Issue custom field options
  • Issue custom field options (apps)
  • Issue custom field values (apps)
  • Issue custom field configuration (apps)
  • Issue navigator settings
  • Issue notification schemes
  • Issue priorities
  • Issue properties
  • Issue resolutions
  • Issue security level
  • Issue security schemes
  • Issue types
  • Issue type schemes
  • Issue type screen schemes
  • Issue type properties
  • Issue votes
  • Issue watchers
  • Issue worklogs
  • Issue worklog properties
  • Jira expressions
  • Jira settings
  • JQL
  • JQL functions (apps)
  • Labels
  • License metrics
  • Myself
  • Permissions
  • Permission schemes
  • Projects
  • Project avatars
  • Project categories
  • Project classification levels
  • Project components
  • Project email
  • Project features
  • Project key and name validation
  • Project permission schemes
  • Project properties
  • Project roles
  • Project role actors
  • Project types
  • Project versions
  • Screens
  • Screen tabs
  • Screen tab fields
  • Screen schemes
  • Server info
  • Status
  • Tasks
  • Time tracking
  • Users
  • User properties
  • Webhooks
  • Workflows
  • Workflow transition rules
  • Workflow schemes
  • Workflow scheme project associations
  • Workflow scheme drafts
  • Workflow statuses
  • Workflow status categories
  • Workflow transition properties
  • App properties
  • Dynamic modules
  • App migration
  • Service Registry
Cloud
Jira Cloud platform / Reference / REST API v2

Screen schemes

Postman Collection
OpenAPI

This resource represents screen schemes in classic projects. Use it to get, create, update, and delete screen schemes.

GET

Get screen schemes

Returns a paginated list of screen schemes.

Only screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-project
Granular:read:screen-scheme:jira, read:issue-type-screen-scheme:jira

Request

Query parameters

startAt

integer

maxResults

integer

id

array<integer>

expand

string

queryString

string

orderBy

string

Responses

Returned if the request is successful.

application/json

PageBeanScreenScheme

A page of items.

GET/rest/api/2/screenscheme
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/screenscheme`, { 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 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 { "isLast": true, "maxResults": 100, "self": "https://your-domain.atlassian.net/rest/api/2/screenscheme?maxResults=25&startAt=0", "startAt": 0, "total": 2, "values": [ { "id": 10010, "name": "Employee screen scheme", "description": "Manage employee data", "screens": { "default": 10017, "edit": 10019, "create": 10019, "view": 10020 }, "issueTypeScreenSchemes": { "isLast": true, "maxResults": 100, "startAt": 0, "total": 1, "values": [ { "id": "10000", "name": "Office issue type screen scheme", "description": "Managing office projects" } ] } }, { "id": 10032, "name": "Office screen scheme", "description": "Manage office data", "screens": { "default": 10020 } } ] }
POST

Create screen scheme

Creates a screen scheme.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:screen-scheme:jira

Request

Request bodyapplication/json

description

string

name

string

Required
screens

ScreenTypes

Required

Responses

Returned if the request is successful.

application/json

ScreenSchemeId

The ID of a screen scheme.

POST/rest/api/2/screenscheme
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "description": "Manage employee data", "name": "Employee screen scheme", "screens": { "default": 10017, "edit": 10019, "view": 10020 } }`; const response = await api.asUser().requestJira(route`/rest/api/2/screenscheme`, { method: 'POST', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
201Response
1 2 3 { "id": 10001 }
PUT

Update screen scheme

Updates a screen scheme. Only screen schemes used in classic projects can be updated.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:screen-scheme:jira

Request

Path parameters

screenSchemeId

string

Required

Request bodyapplication/json

The screen scheme update details.

description

string

name

string

screens

UpdateScreenTypes

Responses

Returned if the request is successful.

application/json

any

PUT/rest/api/2/screenscheme/{screenSchemeId}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "name": "Employee screen scheme v2", "screens": { "create": "10019", "default": "10018" } }`; const response = await api.asUser().requestJira(route`/rest/api/2/screenscheme/{screenSchemeId}`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
DEL

Delete screen scheme

Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme.

Only screens schemes used in classic projects can be deleted.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-project
Granular:delete:screen-scheme:jira

Request

Path parameters

screenSchemeId

string

Required

Responses

Returned if the screen scheme is deleted.

DEL/rest/api/2/screenscheme/{screenSchemeId}
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/screenscheme/{screenSchemeId}`, { method: 'DELETE' }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());

Rate this page: