Cloud

Jira Cloud platform / Reference / REST API v3

Screen schemes

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

Operations

GET/rest/api/3/screenscheme POST/rest/api/3/screenscheme PUT/rest/api/3/screenscheme/{screenSchemeId}DEL/rest/api/3/screenscheme/{screenSchemeId}

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

OAuth 2.0 scopes required:

ClassicRECOMMENDED:manage:jira-project

Granular:read:screen-scheme:jira, read:issue-type-screen-scheme:jira

Connect app scope required: ADMIN

Request

Query parameters

startAt

integer

maxResults

integer

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/3/screenscheme

Forge

curl

Node.js

Java

Python

PHP

// 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/screenscheme`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

{
  "isLast": true,
  "maxResults": 100,
  "self": "https://your-domain.atlassian.net/rest/api/3/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

OAuth 2.0 scopes required:

ClassicRECOMMENDED:manage:jira-configuration

Granular:write:screen-scheme:jira

Connect app scope required: ADMIN

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/3/screenscheme

Forge

curl

Node.js

Java

Python

PHP

// 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/3/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

OAuth 2.0 scopes required:

ClassicRECOMMENDED:manage:jira-configuration

Granular:write:screen-scheme:jira

Connect app scope required: ADMIN

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/3/screenscheme/{screenSchemeId}

Forge

curl

Node.js

Java

Python

PHP

// 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/3/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

OAuth 2.0 scopes required:

ClassicRECOMMENDED:manage:jira-project

Granular:delete:screen-scheme:jira

Connect app scope required: ADMIN

Request

Path parameters

screenSchemeId

string

Required

Responses

Returned if the screen scheme is deleted.

DEL/rest/api/3/screenscheme/{screenSchemeId}

Forge

curl

Node.js

Java

Python

PHP

// 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/screenscheme/{screenSchemeId}`, {
  method: 'DELETE'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());