Open Context Protocol is live! 🚀 Read the launch post

getFields

Get fields

Details

  • Method: GET
  • Path: /rest/api/3/field
  • Operation ID: getFields

Parameters

{}

Response Schema

{
  "items": {
    "additionalProperties": false,
    "description": "Details about a field.",
    "properties": {
      "clauseNames": {
        "description": "The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ).",
        "items": {
          "type": "string"
        },
        "type": "array",
        "uniqueItems": true
      },
      "custom": {
        "description": "Whether the field is a custom field.",
        "type": "boolean"
      },
      "id": {
        "description": "The ID of the field.",
        "type": "string"
      },
      "key": {
        "description": "The key of the field.",
        "type": "string"
      },
      "name": {
        "description": "The name of the field.",
        "type": "string"
      },
      "navigable": {
        "description": "Whether the field can be used as a column on the issue navigator.",
        "type": "boolean"
      },
      "orderable": {
        "description": "Whether the content of the field can be used to order lists.",
        "type": "boolean"
      },
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/JsonTypeBean"
          }
        ],
        "description": "The data schema for the field."
      },
      "scope": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Scope"
          }
        ],
        "description": "The scope of the field."
      },
      "searchable": {
        "description": "Whether the content of the field can be searched.",
        "type": "boolean"
      }
    },
    "type": "object",
    "xml": {
      "name": "field"
    }
  },
  "type": "array"
}

Usage

from ocp_agent import OCPAgent

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

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