Atlassian: Screen schemes schemas
8 Atlassian schemas with complete fields and constraints.
← Screen schemes operations · All schemas
Create screen scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a screen scheme. Additional keys: not allowed |
description | string | Optional | The description of the screen scheme. The maximum length is 255 characters. write Only: true |
name | string | Required within parent | The name of the screen scheme. The name must be unique. The maximum length is 255 characters. write Only: true |
screens | Model | Required within parent | Expand Create screen scheme — request body — body screens The IDs of the screens for the screen types of the screen scheme. Only screens used in classic projects are accepted. |
Referenced models: Create screen scheme — request body — body screens
Create screen scheme — request body — body screens
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The IDs of the screens for the screen types of the screen scheme. write Only: true Additional keys: not allowed |
create | integer | Optional | The ID of the create screen. Format: int64 |
default | integer | Required within parent | The ID of the default screen. Required when creating a screen scheme. Format: int64 |
edit | integer | Optional | The ID of the edit screen. Format: int64 |
view | integer | Optional | The ID of the view screen. Format: int64 |
Create screen scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The ID of a screen scheme. |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the screen scheme. Format: int64 Read only: true |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative |
Get screen schemes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get screen schemes — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get screen schemes — response body — values The list of items item
Get screen schemes — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A screen scheme. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the screen scheme. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the screen scheme. Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
issueTypeScreenSchemes | JSON | Optional | |
issueTypeScreenSchemes (anyOf 1) | Model | Alternative | Expand Get issue type screen schemes — response body Details of the issue type screen schemes associated with the screen scheme. |
issueTypeScreenSchemes (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the screen scheme. |
name (anyOf 2) | null | Alternative | |
screens | JSON | Optional | |
screens (anyOf 1) | Model | Alternative | Expand Get screen schemes — response body — values The list of items item screens create, default, edit, view The IDs of the screens for the screen types of the screen scheme. |
screens (anyOf 2) | null | Alternative |
Referenced models: Get issue type screen schemes — response body, Get screen schemes — response body — values The list of items item screens create, default, edit, view
Get screen schemes — response body — values The list of items item screens create, default, edit, view
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The IDs of the screens for the screen types of the screen scheme. write Only: true |
create | JSON | Optional | |
create (anyOf 1) | JSON | Alternative | |
create (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the create screen. Format: int64 |
create (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
create (anyOf 2) | null | Alternative | |
default | JSON | Optional | |
default (anyOf 1) | JSON | Alternative | |
default (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the default screen. Required when creating a screen scheme. Format: int64 |
default (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
default (anyOf 2) | null | Alternative | |
edit | JSON | Optional | |
edit (anyOf 1) | JSON | Alternative | |
edit (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the edit screen. Format: int64 |
edit (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
edit (anyOf 2) | null | Alternative | |
view | JSON | Optional | |
view (anyOf 1) | JSON | Alternative | |
view (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the view screen. Format: int64 |
view (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
view (anyOf 2) | null | Alternative |
Update screen scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a screen scheme. Additional keys: not allowed |
description | string | Optional | The description of the screen scheme. The maximum length is 255 characters. write Only: true |
name | string | Optional | The name of the screen scheme. The name must be unique. The maximum length is 255 characters. write Only: true |
screens | Model | Optional | Expand Update screen scheme — request body — body screens The IDs of the screens for the screen types of the screen scheme. Only screens used in classic projects are accepted. |
Referenced models: Update screen scheme — request body — body screens
Update screen scheme — request body — body screens
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The IDs of the screens for the screen types of the screen scheme. write Only: true Additional keys: not allowed |
create | string | Optional | The ID of the create screen. To remove the screen association, pass a null. write Only: true |
default | string | Optional | The ID of the default screen. When specified, must include a screen ID as a default screen is required. write Only: true |
edit | string | Optional | The ID of the edit screen. To remove the screen association, pass a null. write Only: true |
view | string | Optional | The ID of the view screen. To remove the screen association, pass a null. write Only: true |