editIssue
Edit issue
Details
- Method:
PUT - Path:
/rest/api/3/issue/{issueIdOrKey} - Operation ID:
editIssue
Parameters
{
"issueIdOrKey": {
"description": "The ID or key of the issue.",
"required": true,
"location": "path",
"type": "string"
},
"notifyUsers": {
"description": "Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored.",
"required": false,
"location": "query",
"type": "boolean"
},
"overrideScreenSecurity": {
"description": "Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).",
"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) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).",
"required": false,
"location": "query",
"type": "boolean"
},
"returnIssue": {
"description": "Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the [Get issue API](#api-rest-api-3-issue-issueidorkey-get).",
"required": false,
"location": "query",
"type": "boolean"
},
"expand": {
"description": "The Get issue API expand parameter to use in the response if the `returnIssue` parameter is `true`.",
"required": false,
"location": "query",
"type": "string"
},
"fields": {
"description": "List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`.",
"required": false,
"location": "body",
"type": "object"
},
"historyMetadata": {
"description": "Additional issue history details.",
"required": false,
"location": "body",
"type": "string"
},
"properties": {
"description": "Details of issue properties to be add or update.",
"required": false,
"location": "body",
"type": "array"
},
"transition": {
"description": "Details of a transition. Required when performing a transition, optional when creating or editing an issue.",
"required": false,
"location": "body",
"type": "string"
},
"update": {
"description": "A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`.",
"required": false,
"location": "body",
"type": "object"
}
}Response Schema
{}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('editIssue', {
# Add required parameters here
})