Atlassian: Issue custom field options apps schemas
12 Atlassian schemas with complete fields and constraints.
← Issue custom field options apps operations · All schemas
Create issue field option — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
config | Model | Optional | Expand Create issue field option — request body — body config |
properties | object | Optional | The properties of the option as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module. Additional keys: see wildcard field |
properties.* | JSON | Additional keys | |
value | string | Required within parent | The option's name, which is displayed in Jira. |
Referenced models: Create issue field option — request body — body config
Create issue field option — request body — body config
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the projects the option is available in. Additional keys: not allowed |
attributes | array | Optional | DEPRECATED Unique items: true |
attributes[] | string | Each item | One of: notSelectable, defaultValue |
scope | Model | Optional | Expand Create issue field option — request body — body config scope Defines the projects that the option is available in. If the scope is not defined, then the option is available in all projects. |
Referenced models: Create issue field option — request body — body config scope
Create issue field option — request body — body config scope
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
global | Model | Optional | Expand Create issue field option — request body — body config scope global Defines the behavior of the option within the global context. If this property is set, even if set to an empty object, then the option is available in all projects. |
projects | array | Optional | DEPRECATED Unique items: true |
projects[] | integer | Each item | Format: int64 |
projects2 | array | Optional | Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context. Unique items: true |
projects2[] | Model | Each item | Expand Create issue field option — request body — body config scope projects2 item |
Referenced models: Create issue field option — request body — body config scope global, Create issue field option — request body — body config scope projects2 item
Create issue field option — request body — body config scope global
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
attributes | array | Optional | Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default. Unique items: true |
attributes[] | string | Each item | One of: notSelectable, defaultValue |
Create issue field option — request body — body config scope projects2 item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
attributes | array | Optional | Defines the behavior of the option in the project.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default. Unique items: true |
attributes[] | string | Each item | One of: notSelectable, defaultValue |
id | integer | Optional | The ID of the project that the option's behavior applies to. Format: int64 |
Get all issue field options — 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 field option — response body |
values (anyOf 2) | null | Alternative |
Referenced models: Get issue field option — response body
Get issue field option — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the options for a select list issue field. |
config | JSON | Optional | |
config (anyOf 1) | Model | Alternative | Expand Get issue field option — response body — config Details of the projects the option is available in |
config (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The unique identifier for the option. This is only unique within the select field's set of options. Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
properties | JSON | Optional | |
properties (anyOf 1) | object | Alternative | The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see [Issue Field Option Property Index](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/)) are defined in the descriptor for the issue field module. Additional keys: see wildcard field |
properties (anyOf 1).* | JSON | Additional keys | |
properties (anyOf 2) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | The option's name, which is displayed in Jira. |
value (anyOf 2) | null | Alternative |
Referenced models: Get issue field option — response body — config Details of the projects the option is available in
Get issue field option — response body — config Details of the projects the option is available in
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the projects the option is available in. |
attributes | JSON | Optional | |
attributes (anyOf 1) | array | Alternative | DEPRECATED Unique items: true |
attributes (anyOf 1)[] | string | Each item | Known values: notSelectable, defaultValue |
attributes (anyOf 2) | null | Alternative | |
scope | JSON | Optional | |
scope (anyOf 1) | Model | Alternative | Expand Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 Defines the projects that the option is available in. If the scope is not defined, then the option is available in all projects. |
scope (anyOf 2) | null | Alternative |
Referenced models: Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2
Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
global | JSON | Optional | |
global (anyOf 1) | Model | Alternative | Expand Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 global attributes Defines the behavior of the option within the global context. If this property is set, even if set to an empty object, then the option is available in all projects. |
global (anyOf 2) | null | Alternative | |
projects | JSON | Optional | |
projects (anyOf 1) | array | Alternative | DEPRECATED Unique items: true |
projects (anyOf 1)[] | JSON | Each item | |
projects (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
projects (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
projects (anyOf 2) | null | Alternative | |
projects2 | JSON | Optional | |
projects2 (anyOf 1) | array | Alternative | Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context. Unique items: true |
projects2 (anyOf 1)[] | Model | Each item | Expand Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 projects2 array item |
projects2 (anyOf 2) | null | Alternative |
Referenced models: Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 global attributes, Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 projects2 array item
Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 global attributes
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attributes | JSON | Optional | |
attributes (anyOf 1) | array | Alternative | Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default. Unique items: true |
attributes (anyOf 1)[] | string | Each item | Known values: notSelectable, defaultValue |
attributes (anyOf 2) | null | Alternative |
Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 projects2 array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attributes | JSON | Optional | |
attributes (anyOf 1) | array | Alternative | Defines the behavior of the option in the project.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default. Unique items: true |
attributes (anyOf 1)[] | string | Each item | Known values: notSelectable, defaultValue |
attributes (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the project that the option's behavior applies to. Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative |
Update issue field option — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the options for a select list issue field. Additional keys: not allowed |
config | Model | Optional | Expand Create issue field option — request body — body config |
id | integer | Required within parent | The unique identifier for the option. This is only unique within the select field's set of options. Format: int64 |
properties | object | Optional | The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see [Issue Field Option Property Index](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/)) are defined in the descriptor for the issue field module. Additional keys: see wildcard field |
properties.* | JSON | Additional keys | |
value | string | Required within parent | The option's name, which is displayed in Jira. |
Referenced models: Create issue field option — request body — body config