Atlassian: Issue custom field options schemas
11 Atlassian schemas with complete fields and constraints.
← Issue custom field options operations · All schemas
Create custom field options (context) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the options to create for a custom field. write Only: true Additional keys: not allowed |
options | array | Optional | Details of options to create. |
options[] | Model | Each item | Expand Create custom field options (context) — request body — body options item |
Referenced models: Create custom field options (context) — request body — body options item
Create custom field options (context) — request body — body options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a custom field option to create. Additional keys: not allowed |
disabled | boolean | Optional | Whether the option is disabled. |
optionId | string | Optional | For cascading options, the ID of a parent option. |
value | string | Required within parent | The value of the custom field option. |
Create custom field options (context) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of custom field options for a context. |
options | JSON | Optional | |
options (anyOf 1) | array | Alternative | The created custom field options. |
options (anyOf 1)[] | Model | Each item | Expand Get custom field options (context) — response body — values The list of items item |
options (anyOf 2) | null | Alternative |
Referenced models: Get custom field options (context) — response body — values The list of items item
Get custom field option — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a custom option for a field. |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of these custom field option details. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | The value of the custom field option. Read only: true |
value (anyOf 2) | null | Alternative |
Get custom field options (context) — 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 custom field options (context) — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get custom field options (context) — response body — values The list of items item
Get custom field options (context) — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the custom field options for a context. |
disabled | JSON | Optional | |
disabled (anyOf 1) | boolean | Alternative | Whether the option is disabled. |
disabled (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the custom field option. |
id (anyOf 2) | null | Alternative | |
optionId | JSON | Optional | |
optionId (anyOf 1) | string | Alternative | For cascading options, the ID of the custom field option containing the cascading option. |
optionId (anyOf 2) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | The value of the custom field option. |
value (anyOf 2) | null | Alternative |
Reorder custom field options (context) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An ordered list of custom field option IDs and information on where to move them. Additional keys: not allowed |
after | string | Optional | The ID of the custom field option or cascading option to place the moved options after. Required if `position` isn't provided. write Only: true |
customFieldOptionIds | array | Required within parent | A list of IDs of custom field options to move. The order of the custom field option IDs in the list is the order they are given after the move. The list must contain custom field options or cascading options, but not both. write Only: true |
customFieldOptionIds[] | string | Each item | write Only: true |
position | string | Optional | The position the custom field options should be moved to. Required if `after` isn't provided. One of: First, Last write Only: true |
Update custom field options (context) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the options to update for a custom field. write Only: true Additional keys: not allowed |
options | array | Optional | Details of the options to update. |
options[] | Model | Each item | Expand Update custom field options (context) — request body — body options item |
Referenced models: Update custom field options (context) — request body — body options item
Update custom field options (context) — request body — body options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a custom field option for a context. Additional keys: not allowed |
disabled | boolean | Optional | Whether the option is disabled. |
id | string | Required within parent | The ID of the custom field option. |
value | string | Optional | The value of the custom field option. |
Update custom field options (context) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of custom field options for a context. |
options | JSON | Optional | |
options (anyOf 1) | array | Alternative | The updated custom field options. |
options (anyOf 1)[] | Model | Each item | Expand Update custom field options (context) — response body — options The updated custom field options item |
options (anyOf 2) | null | Alternative |
Referenced models: Update custom field options (context) — response body — options The updated custom field options item
Update custom field options (context) — response body — options The updated custom field options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a custom field option for a context. |
disabled | JSON | Optional | |
disabled (anyOf 1) | boolean | Alternative | Whether the option is disabled. |
disabled (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the custom field option. |
id (anyOf 2) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | The value of the custom field option. |
value (anyOf 2) | null | Alternative |