Atlassian: Issue type screen schemes schemas
15 Atlassian schemas with complete fields and constraints.
← Issue type screen schemes operations · All schemas
Append mappings to issue type screen scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of issue type screen scheme mappings. Additional keys: not allowed |
issueTypeMappings | array | Required within parent | The list of issue type to screen scheme mappings. A *default* entry cannot be specified because a default entry is added when an issue type screen scheme is created. write Only: true |
issueTypeMappings[] | Model | Each item | Expand Create issue type screen scheme — request body — body issue Type Mappings item |
Referenced models: Create issue type screen scheme — request body — body issue Type Mappings item
Assign issue type screen scheme to project — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Associated issue type screen scheme and project. Additional keys: not allowed |
issueTypeScreenSchemeId | string | Optional | The ID of the issue type screen scheme. write Only: true |
projectId | string | Optional | The ID of the project. write Only: true |
Create issue type screen scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The details of an issue type screen scheme. Additional keys: not allowed |
description | string | Optional | The description of the issue type screen scheme. The maximum length is 255 characters. write Only: true |
issueTypeMappings | array | Required within parent | The IDs of the screen schemes for the issue type IDs and *default*. A *default* entry is required to create an issue type screen scheme, it defines the mapping for all issue types without a screen scheme. write Only: true |
issueTypeMappings[] | Model | Each item | Expand Create issue type screen scheme — request body — body issue Type Mappings item |
name | string | Required within parent | The name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters. write Only: true |
Referenced models: Create issue type screen scheme — request body — body issue Type Mappings item
Create issue type screen scheme — request body — body issue Type Mappings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The IDs of the screen schemes for the issue type IDs. write Only: true Additional keys: not allowed |
issueTypeId | string | Required within parent | The ID of the issue type or *default*. Only issue types used in classic projects are accepted. An entry for *default* must be provided and defines the mapping for all issue types without a screen scheme. write Only: true |
screenSchemeId | string | Required within parent | The ID of the screen scheme. Only screen schemes used in classic projects are accepted. write Only: true |
Create issue type screen scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The ID of an issue type screen scheme. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue type screen scheme. Read only: true |
id (anyOf 2) | null | Alternative |
Get issue type screen scheme items — 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 issue type screen scheme items — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get issue type screen scheme items — response body — values The list of items item
Get issue type screen scheme items — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The screen scheme for an issue type. |
issueTypeId | JSON | Optional | |
issueTypeId (anyOf 1) | string | Alternative | The ID of the issue type or *default*. Only issue types used in classic projects are accepted. When creating an issue screen scheme, an entry for *default* must be provided and defines the mapping for all issue types without a screen scheme. Otherwise, a *default* entry can't be provided. |
issueTypeId (anyOf 2) | null | Alternative | |
issueTypeScreenSchemeId | JSON | Optional | |
issueTypeScreenSchemeId (anyOf 1) | string | Alternative | The ID of the issue type screen scheme. |
issueTypeScreenSchemeId (anyOf 2) | null | Alternative | |
screenSchemeId | JSON | Optional | |
screenSchemeId (anyOf 1) | string | Alternative | The ID of the screen scheme. |
screenSchemeId (anyOf 2) | null | Alternative |
Get issue type screen scheme projects — 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 issue type screen scheme projects — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get issue type screen scheme projects — response body — values The list of items item
Get issue type screen scheme projects — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a project. |
avatarUrls | JSON | Optional | |
avatarUrls (anyOf 1) | Model | Alternative | Expand Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48 The URLs of the project's avatars. Read only: true |
avatarUrls (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the project. |
id (anyOf 2) | null | Alternative | |
key | JSON | Optional | |
key (anyOf 1) | string | Alternative | The key of the project. Read only: true |
key (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the project. Read only: true |
name (anyOf 2) | null | Alternative | |
projectCategory | JSON | Optional | |
projectCategory (anyOf 1) | Model | Alternative | Expand Update project category — response body The category the project belongs to. Read only: true |
projectCategory (anyOf 2) | null | Alternative | |
projectTypeKey | JSON | Optional | |
projectTypeKey (anyOf 1) | string | Alternative | The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. Known values: software, service_desk, business, product_discovery Read only: true |
projectTypeKey (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the project details. Read only: true |
self (anyOf 2) | null | Alternative | |
simplified | JSON | Optional | |
simplified (anyOf 1) | boolean | Alternative | Whether or not the project is simplified. Read only: true |
simplified (anyOf 2) | null | Alternative |
Referenced models: Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48, Update project category — response body
Get issue type screen schemes for projects — 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 issue type screen schemes for projects — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get issue type screen schemes for projects — response body — values The list of items item
Get issue type screen schemes for projects — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue type screen scheme with a list of the projects that use it. |
issueTypeScreenScheme | JSON | Optional | |
issueTypeScreenScheme (anyOf 1) | Model | Alternative | Expand Get issue type screen schemes — response body — values The list of items item Details of an issue type screen scheme. |
issueTypeScreenScheme (anyOf 2) | null | Alternative | |
projectIds | JSON | Optional | |
projectIds (anyOf 1) | array | Alternative | The IDs of the projects using the issue type screen scheme. |
projectIds (anyOf 1)[] | string | Each item | |
projectIds (anyOf 2) | null | Alternative |
Referenced models: Get issue type screen schemes — response body — values The list of items item
Get issue type 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 issue type screen schemes — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get issue type screen schemes — response body — values The list of items item
Get issue type screen schemes — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an issue type screen scheme. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the issue type screen scheme. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue type screen scheme. |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the issue type screen scheme. |
name (anyOf 2) | null | Alternative |
Update issue type screen scheme default screen scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The ID of a screen scheme. Additional keys: not allowed |
screenSchemeId | string | Required within parent | The ID of the screen scheme. write Only: true |
Update issue type screen scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an issue type screen scheme. Additional keys: not allowed |
description | string | Optional | The description of the issue type screen scheme. The maximum length is 255 characters. write Only: true |
name | string | Optional | The name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters. write Only: true |