Update screen scheme

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

Permissions required: Administer Jira global permission.

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/screenscheme/' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "Employee screen scheme v2", "screens": { "create": "10019", "default": "10018" } }'

Request

Path Params

screenSchemeId

string

required

The ID of the screen scheme.

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-onlyoptional

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

screens

object

write-onlyoptional

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

create

string

write-onlyoptional

The ID of the create screen. To remove the screen association, pass a null.

default

string

write-onlyoptional

The ID of the default screen. When specified, must include a screen ID as a default screen is required.

edit

string

write-onlyoptional

The ID of the edit screen. To remove the screen association, pass a null.

view

string

write-onlyoptional

The ID of the view screen. To remove the screen association, pass a null.

Examples

Responses

🟢204Returned if the request is successful.

application/json

Body

No schema defined

🟠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 the screen scheme or a screen used as one of the screen types is not found.