Create screen scheme

Creates a screen scheme.

Permissions required: Administer Jira global permission.

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/screenscheme' \ --header 'Content-Type: application/json' \ --data-raw '{ "description": "Manage employee data", "name": "Employee screen scheme", "screens": { "default": 10017, "edit": 10019, "view": 10020 } }'

Request

Body Params application/json

Details of a screen scheme.

description

string

write-onlyoptional

The description of the screen scheme. The maximum length is 255 characters.

name

string

write-onlyrequired

The name of the screen scheme. The name must be unique. The maximum length is 255 characters.

screens

object

write-onlyrequired

The IDs of the screens for the screen types of the screen scheme. Only screens used in classic projects are accepted.

create

integer <int64>

optional

The ID of the create screen.

default

integer <int64>

optional

The ID of the default screen. Required when creating a screen scheme.

edit

integer <int64>

optional

The ID of the edit screen.

view

integer <int64>

optional

The ID of the view screen.

Examples

Responses

🟢201Returned if the request is successful.

application/json

Body

The ID of a screen scheme.

integer <int64>

read-onlyrequired

The ID of the screen scheme.

🟠400Returned if the request is not valid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have the required permissions.

🟠404Returned if a screen used as one of the screen types in the screen scheme is not found.