Update custom field options (context)

PUT

/rest/api/3/field/{fieldId}/context/{contextId}/option

Updates the options of a custom field.

If any of the options are not found, no options are updated. Options where the values in the request match the current values aren't updated and aren't reported in the response.

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

Permissions required: Administer Jira global permission.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/field//context//option' \
--header 'Content-Type: application/json' \
--data-raw '{
    "options": [
        {
            "disabled": false,
            "id": "10001",
            "value": "Scranton"
        },
        {
            "disabled": true,
            "id": "10002",
            "value": "Manhattan"
        },
        {
            "disabled": false,
            "id": "10003",
            "value": "The Electric City"
        }
    ]
}'

Response Example

200 - Success

{"options":[{"id":"10001","value":"Scranton","disabled":false},{"id":"10002","value":"Manhattan","disabled":true},{"id":"10003","value":"The Electric City","disabled":false}]}

Request

Path Params

fieldId

string

required

The ID of the custom field.

contextId

integer

required

The ID of the context.

Body Params application/json

Details of the options to update for a custom field.

options

array[object (CustomFieldOptionUpdate) {3}]

optional

Details of the options to update.

disabled

boolean

optional

Whether the option is disabled.

string

required

The ID of the custom field option.

value

string

optional

The value of the custom field option.

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

A list of custom field options for a context.

options

array[object (CustomFieldOptionUpdate) {3}]

optional

The updated custom field options.

disabled

boolean

optional

Whether the option is disabled.

string

required

The ID of the custom field option.

value

string

optional

The value of the custom field option.

🟠400Returned if the request is not valid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have the necessary permission.

🟠404Returned if the field, context, or one or more options is not found.

Modified at 2023-07-13 03:27:27

Get custom field options (context)

Create custom field options (context)