replaceIssueFieldOption
Replace issue field option
Details
- Method:
DELETE - Path:
/rest/api/3/field/{fieldKey}/option/{optionId}/issue - Operation ID:
replaceIssueFieldOption
Parameters
{
"replaceWith": {
"description": "The ID of the option that will replace the currently selected option.",
"required": false,
"location": "query",
"type": "integer",
"format": "int64"
},
"jql": {
"description": "A JQL query that specifies the issues to be updated. For example, *project=10000*.",
"required": false,
"location": "query",
"type": "string"
},
"overrideScreenSecurity": {
"description": "Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission.",
"required": false,
"location": "query",
"type": "boolean"
},
"overrideEditableFlag": {
"description": "Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).",
"required": false,
"location": "query",
"type": "boolean"
},
"fieldKey": {
"description": "The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following:\n\n * 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.\n * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"`",
"required": true,
"location": "path",
"type": "string"
},
"optionId": {
"description": "The ID of the option to be deselected.",
"required": true,
"location": "path",
"type": "integer",
"format": "int64"
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('replaceIssueFieldOption', {
# Add required parameters here
})