Create screen

POST

/rest/api/3/screens

Creates a screen with a default field tab.

Permissions required: Administer Jira global permission.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/screens' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "Enables changes to resolution and linked issues.",
    "name": "Resolve Security Issue Screen"
}'

Response Example

201 - Success

{"id":10005,"name":"Resolve Security Issue Screen","description":"Enables changes to resolution and linked issues."}

Request

Body Params application/json

Details of a screen.

description

string

write-onlyoptional

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

name

string

write-onlyrequired

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

Examples

Responses

🟢201Returned if the request is successful.

application/json

Body

A screen.

description

string

read-onlyoptional

The description of the screen.

integer <int64>

read-onlyoptional

The ID of the screen.

name

string

read-onlyoptional

The name of the screen.

scope

object

optional

The scope of the screen.

project

object

read-onlyoptional

The project the item has scope in.

type

enum<string>

read-onlyoptional

The type of scope.

Allowed values:

PROJECTTEMPLATE

Additional properties

integer | number | string | boolean

optional

🟠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.

Modified at 2023-07-13 03:27:27

Get screens

Add field to default screen