Open Context Protocol is live! 🚀 Read the launch post
updateIssueFieldOption

updateIssueFieldOption

Update issue field option

Details

  • Method: PUT
  • Path: /rest/api/3/field/{fieldKey}/option/{optionId}
  • Operation ID: updateIssueFieldOption

Parameters

{
  "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 updated.",
    "required": true,
    "location": "path",
    "type": "integer",
    "format": "int64"
  },
  "config": {
    "description": "Details of the projects the option is available in.",
    "required": false,
    "location": "body",
    "type": "object"
  },
  "id": {
    "description": "The unique identifier for the option. This is only unique within the select field's set of options.",
    "required": true,
    "location": "body",
    "type": "integer"
  },
  "properties": {
    "description": "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](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/)) are defined in the descriptor for the issue field module.",
    "required": false,
    "location": "body",
    "type": "object"
  },
  "value": {
    "description": "The option's name, which is displayed in Jira.",
    "required": true,
    "location": "body",
    "type": "string"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "Details of the options for a select list issue field.",
  "properties": {
    "config": {
      "additionalProperties": false,
      "description": "Details of the projects the option is available in.",
      "properties": {
        "attributes": {
          "description": "DEPRECATED",
          "items": {
            "enum": [
              "notSelectable",
              "defaultValue"
            ],
            "type": "string"
          },
          "type": "array",
          "uniqueItems": true
        },
        "scope": {
          "allOf": [
            {
              "$ref": "#/components/schemas/IssueFieldOptionScopeBean"
            }
          ],
          "description": "Defines the projects that the option is available in. If the scope is not defined, then the option is available in all projects."
        }
      },
      "type": "object"
    },
    "id": {
      "description": "The unique identifier for the option. This is only unique within the select field's set of options.",
      "format": "int64",
      "type": "integer"
    },
    "properties": {
      "additionalProperties": {},
      "description": "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](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/)) are defined in the descriptor for the issue field module.",
      "type": "object"
    },
    "value": {
      "description": "The option's name, which is displayed in Jira.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "value"
  ],
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('jira')

# Call this tool
result = await agent.call_tool('updateIssueFieldOption', {
    # Add required parameters here
})