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

getAutoCompletePost

Get field reference data (POST)

Details

  • Method: POST
  • Path: /rest/api/3/jql/autocompletedata
  • Operation ID: getAutoCompletePost

Parameters

{
  "includeCollapsedFields": {
    "description": "Include collapsed fields for fields that have non-unique names.",
    "required": false,
    "location": "body",
    "type": "boolean"
  },
  "projectIds": {
    "description": "List of project IDs used to filter the visible field details returned.",
    "required": false,
    "location": "body",
    "type": "array"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "Lists of JQL reference data.",
  "properties": {
    "jqlReservedWords": {
      "description": "List of JQL query reserved words.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "visibleFieldNames": {
      "description": "List of fields usable in JQL queries.",
      "items": {
        "additionalProperties": false,
        "description": "Details of a field that can be used in advanced searches.",
        "properties": {
          "auto": {
            "description": "Whether the field provide auto-complete suggestions.",
            "enum": [
              "true",
              "false"
            ],
            "type": "string"
          },
          "cfid": {
            "description": "If the item is a custom field, the ID of the custom field.",
            "type": "string"
          },
          "deprecated": {
            "description": "Whether this field has been deprecated.",
            "enum": [
              "true",
              "false"
            ],
            "type": "string"
          },
          "deprecatedSearcherKey": {
            "description": "The searcher key of the field, only passed when the field is deprecated.",
            "type": "string"
          },
          "displayName": {
            "description": "The display name contains the following:\n\n *  for system fields, the field name. For example, `Summary`.\n *  for collapsed custom fields, the field name followed by a hyphen and then the field name and field type. For example, `Component - Component[Dropdown]`.\n *  for other custom fields, the field name followed by a hyphen and then the custom field ID. For example, `Component - cf[10061]`.",
            "type": "string"
          },
          "operators": {
            "description": "The valid search operators for the field.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "orderable": {
            "description": "Whether the field can be used in a query's `ORDER BY` clause.",
            "enum": [
              "true",
              "false"
            ],
            "type": "string"
          },
          "searchable": {
            "description": "Whether the content of this field can be searched.",
            "enum": [
              "true",
              "false"
            ],
            "type": "string"
          },
          "types": {
            "description": "The data types of items in the field.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "value": {
            "description": "The field identifier.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "visibleFunctionNames": {
      "description": "List of functions usable in JQL queries.",
      "items": {
        "additionalProperties": false,
        "description": "Details of functions that can be used in advanced searches.",
        "properties": {
          "displayName": {
            "description": "The display name of the function.",
            "type": "string"
          },
          "isList": {
            "description": "Whether the function can take a list of arguments.",
            "enum": [
              "true",
              "false"
            ],
            "type": "string"
          },
          "supportsListAndSingleValueOperators": {
            "description": "Whether the function supports both single and list value operators.",
            "enum": [
              "true",
              "false"
            ],
            "type": "string"
          },
          "types": {
            "description": "The data types returned by the function.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "value": {
            "description": "The function identifier.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

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

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