Atlassian: Issue field configurations schemas
19 Atlassian schemas with complete fields and constraints.
← Issue field configurations operations · All schemas
Assign field configuration scheme to project — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Associated field configuration scheme and project. Additional keys: not allowed |
fieldConfigurationSchemeId | string | Optional | The ID of the field configuration scheme. If the field configuration scheme ID is `null`, the operation assigns the default field configuration scheme. write Only: true |
projectId | string | Required within parent | The ID of the project. write Only: true |
Assign issue types to field configurations — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a field configuration to issue type mappings. Additional keys: not allowed |
mappings | array | Required within parent | Field configuration to issue type mappings. Unique items: true write Only: true |
mappings[] | Model | Each item | Expand Assign issue types to field configurations — request body — body mappings item |
Referenced models: Assign issue types to field configurations — request body — body mappings item
Assign issue types to field configurations — request body — body mappings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The field configuration to issue type mapping. write Only: true Additional keys: not allowed |
fieldConfigurationId | string | Required within parent | The ID of the field configuration. write Only: true |
issueTypeId | string | Required within parent | The ID of the issue type or *default*. When set to *default* this field configuration issue type item applies to all issue types without a field configuration. An issue type can be included only once in a request. write Only: true |
Create field configuration scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The details of the field configuration scheme. Additional keys: not allowed |
description | string | Optional | The description of the field configuration scheme. Maximum length: 1024 write Only: true |
name | string | Required within parent | The name of the field configuration scheme. The name must be unique. Maximum length: 255 write Only: true |
Create field configuration scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a field configuration scheme. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the field configuration scheme. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the field configuration scheme. |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the field configuration scheme. |
name (anyOf 2) | null | Alternative |
Create field configuration — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a field configuration. Additional keys: not allowed |
description | string | Optional | The description of the field configuration. Maximum length: 255 write Only: true |
name | string | Required within parent | The name of the field configuration. Must be unique. Maximum length: 255 write Only: true |
Create field configuration — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a field configuration. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the field configuration. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the field configuration. Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
isDefault | JSON | Optional | |
isDefault (anyOf 1) | boolean | Alternative | Whether the field configuration is the default. |
isDefault (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the field configuration. |
name (anyOf 2) | null | Alternative |
Get all field configuration 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 Create field configuration scheme — response body |
values (anyOf 2) | null | Alternative |
Referenced models: Create field configuration scheme — response body
Get all field configurations — 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 all field configurations — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get all field configurations — response body — values The list of items item
Get all field configurations — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a field configuration. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the field configuration. Maximum length: 255 write Only: true |
description (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the field configuration. Must be unique. Maximum length: 255 write Only: true |
name (anyOf 2) | null | Alternative |
Get field configuration issue type 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 field configuration issue type items — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get field configuration issue type items — response body — values The list of items item
Get field configuration issue type items — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The field configuration for an issue type. |
fieldConfigurationId | JSON | Optional | |
fieldConfigurationId (anyOf 1) | string | Alternative | The ID of the field configuration. |
fieldConfigurationId (anyOf 2) | null | Alternative | |
fieldConfigurationSchemeId | JSON | Optional | |
fieldConfigurationSchemeId (anyOf 1) | string | Alternative | The ID of the field configuration scheme. |
fieldConfigurationSchemeId (anyOf 2) | null | Alternative | |
issueTypeId | JSON | Optional | |
issueTypeId (anyOf 1) | string | Alternative | The ID of the issue type or *default*. When set to *default* this field configuration issue type item applies to all issue types without a field configuration. |
issueTypeId (anyOf 2) | null | Alternative |
Get field configuration 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 field configuration items — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get field configuration items — response body — values The list of items item
Get field configuration items — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A field within a field configuration. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the field within the field configuration. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the field within the field configuration. |
id (anyOf 2) | null | Alternative | |
isHidden | JSON | Optional | |
isHidden (anyOf 1) | boolean | Alternative | Whether the field is hidden in the field configuration. |
isHidden (anyOf 2) | null | Alternative | |
isRequired | JSON | Optional | |
isRequired (anyOf 1) | boolean | Alternative | Whether the field is required in the field configuration. |
isRequired (anyOf 2) | null | Alternative | |
renderer | JSON | Optional | |
renderer (anyOf 1) | string | Alternative | The renderer type for the field within the field configuration. |
renderer (anyOf 2) | null | Alternative |
Get field configuration 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 field configuration schemes for projects — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get field configuration schemes for projects — response body — values The list of items item
Get field configuration schemes for projects — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Project list with assigned field configuration schema. |
fieldConfigurationScheme | JSON | Optional | |
fieldConfigurationScheme (anyOf 1) | Model | Alternative | Expand Create field configuration scheme — response body |
fieldConfigurationScheme (anyOf 2) | null | Alternative | |
projectIds | JSON | Optional | |
projectIds (anyOf 1) | array | Alternative | The IDs of projects using the field configuration scheme. |
projectIds (anyOf 1)[] | string | Each item | The IDs of projects using the field configuration scheme. |
projectIds (anyOf 2) | null | Alternative |
Referenced models: Create field configuration scheme — response body
Remove issue types from field configuration scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The list of issue type IDs to be removed from the field configuration scheme. Additional keys: not allowed |
issueTypeIds | array | Required within parent | The list of issue type IDs. Must contain unique values not longer than 255 characters and not be empty. Maximum of 100 IDs. |
issueTypeIds[] | string | Each item |
Update field configuration items — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of field configuration items. Additional keys: not allowed |
fieldConfigurationItems | array | Required within parent | Details of fields in a field configuration. write Only: true |
fieldConfigurationItems[] | Model | Each item | Expand Update field configuration items — request body — body field Configuration Items item |
Referenced models: Update field configuration items — request body — body field Configuration Items item
Update field configuration items — request body — body field Configuration Items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A field within a field configuration. Additional keys: not allowed |
description | string | Optional | The description of the field within the field configuration. |
id | string | Required within parent | The ID of the field within the field configuration. |
isHidden | boolean | Optional | Whether the field is hidden in the field configuration. |
isRequired | boolean | Optional | Whether the field is required in the field configuration. |
renderer | string | Optional | The renderer type for the field within the field configuration. |