Update issue field option

Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical.

Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/field//option/' \ --header 'Content-Type: application/json' \ --data-raw '{ "config": { "attributes": [], "scope": { "global": {}, "projects": [], "projects2": [ { "attributes": [ "notSelectable" ], "id": 1002 }, { "attributes": [ "notSelectable" ], "id": 1001 } ] } }, "id": 1, "properties": { "description": "The team'\''s description", "founded": "2016-06-06", "leader": { "email": "lname@example.com", "name": "Leader Name" }, "members": 42 }, "value": "Team 1" }'

{"id":1,"value":"Team 1","properties":{"leader":{"name":"Leader Name","email":"lname@example.com"},"members":42,"description":"The team's description","founded":"2016-06-06"},"config":{"scope":{"projects":[],"projects2":[{"id":1002,"attributes":["notSelectable"]},{"id":1001,"attributes":["notSelectable"]}],"global":{}},"attributes":[]}}

Request

Path Params

fieldKey

string

required

The field key is specified in the following format: $(a pp - k ey)__$ (field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager.

run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

optionId

integer

required

The ID of the option to be updated.

Body Params application/json

Details of the options for a select list issue field.

config

object (IssueFieldOptionConfiguration)

optional

Details of the projects the option is available in.

attributes

array[string]

optional

DEPRECATED

Allowed values:

notSelectabledefaultValue

scope

object

optional

Defines the projects that the option is available in. If the scope is not defined, then the option is available in all projects.

integer <int64>

required

The unique identifier for the option. This is only unique within the select field's set of options.

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) are defined in the descriptor for the issue field module.

Additional properties

integer | number | string | boolean

optional

value

string

required

The option's name, which is displayed in Jira.

Examples

Responses

🟢200Returned if the option is updated or created.

application/json

Body

Details of the options for a select list issue field.

config

object (IssueFieldOptionConfiguration)

optional

Details of the projects the option is available in.

attributes

array[string]

optional

DEPRECATED

Allowed values:

notSelectabledefaultValue

scope

object

optional

Defines the projects that the option is available in. If the scope is not defined, then the option is available in all projects.

integer <int64>

required

The unique identifier for the option. This is only unique within the select field's set of options.

properties

object

optional

Additional properties

integer | number | string | boolean

optional

value

string

required

The option's name, which is displayed in Jira.

🟠400Returned if the option is invalid, or the *ID* in the request object does not match the *optionId* parameter.

🟠403Returned if the request is not authenticated as a Jira administrator or the app that provided the field.

🟠404Returned if field is not found.