DELETE /rest/api/2/field/{fieldKey}/option/{optionId}/issue
Deselects an issue-field select-list option from all issues where it is selected. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query.
Connect and Forge app users with Administer Jira global permission can override the screen security configuration using overrideScreenSecurity and overrideEditableFlag.
This is an asynchronous operation. The response object contains a link to the long-running task.
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.
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
fieldKey |
String | Yes |
The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the
|
optionId |
Integer | Yes |
The ID of the option to be deselected. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
overrideScreenSecurity |
Boolean | No |
Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission. Default value: false |
overrideEditableFlag |
Boolean | No |
Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with Administer Jira global permission. Default value: false |
replaceWith |
Integer | No |
The ID of the option that will replace the currently selected option. |
jql |
String | No |
A JQL query that specifies the issues to be updated. For example, project=10000. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.