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

updateCustomField

Update custom field

Details

  • Method: PUT
  • Path: /rest/api/3/field/{fieldId}
  • Operation ID: updateCustomField

Parameters

{
  "fieldId": {
    "description": "The ID of the custom field.",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "description": {
    "description": "The description of the custom field. The maximum length is 40000 characters.",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "name": {
    "description": "The name of the custom field. It doesn't have to be unique. The maximum length is 255 characters.",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "searcherKey": {
    "description": "The searcher that defines the way the field is searched in Jira. It can be set to `null`, otherwise you must specify the valid searcher for the field type, as listed below (abbreviated values shown):\n\n *  `cascadingselect`: `cascadingselectsearcher`\n *  `datepicker`: `daterange`\n *  `datetime`: `datetimerange`\n *  `float`: `exactnumber` or `numberrange`\n *  `grouppicker`: `grouppickersearcher`\n *  `importid`: `exactnumber` or `numberrange`\n *  `labels`: `labelsearcher`\n *  `multicheckboxes`: `multiselectsearcher`\n *  `multigrouppicker`: `multiselectsearcher`\n *  `multiselect`: `multiselectsearcher`\n *  `multiuserpicker`: `userpickergroupsearcher`\n *  `multiversion`: `versionsearcher`\n *  `project`: `projectsearcher`\n *  `radiobuttons`: `multiselectsearcher`\n *  `readonlyfield`: `textsearcher`\n *  `select`: `multiselectsearcher`\n *  `textarea`: `textsearcher`\n *  `textfield`: `textsearcher`\n *  `url`: `exacttextsearcher`\n *  `userpicker`: `userpickergroupsearcher`\n *  `version`: `versionsearcher`",
    "required": false,
    "location": "body",
    "type": "string",
    "enum": [
      "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher",
      "com.atlassian.jira.plugin.system.customfieldtypes:daterange",
      "com.atlassian.jira.plugin.system.customfieldtypes:datetimerange",
      "com.atlassian.jira.plugin.system.customfieldtypes:exactnumber",
      "com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher",
      "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher",
      "com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher",
      "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher",
      "com.atlassian.jira.plugin.system.customfieldtypes:numberrange",
      "com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher",
      "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher",
      "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher",
      "com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher"
    ]
  }
}

Response Schema

{}

Usage

from ocp_agent import OCPAgent

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

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