getFieldAutoCompleteForQueryString
Get field auto complete suggestions
Details
- Method:
GET - Path:
/rest/api/3/jql/autocompletedata/suggestions - Operation ID:
getFieldAutoCompleteForQueryString
Parameters
{
"fieldName": {
"description": "The name of the field.",
"required": false,
"location": "query",
"type": "string"
},
"fieldValue": {
"description": "The partial field item name entered by the user.",
"required": false,
"location": "query",
"type": "string"
},
"predicateName": {
"description": "The name of the [ CHANGED operator predicate](https://confluence.atlassian.com/x/hQORLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED) for which the suggestions are generated. The valid predicate operators are *by*, *from*, and *to*.",
"required": false,
"location": "query",
"type": "string"
},
"predicateValue": {
"description": "The partial predicate item name entered by the user.",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"additionalProperties": false,
"description": "The results from a JQL query.",
"properties": {
"results": {
"description": "The list of suggested item.",
"items": {
"additionalProperties": false,
"description": "A field auto-complete suggestion.",
"properties": {
"displayName": {
"description": "The display name of a suggested item. If `fieldValue` or `predicateValue` are provided, the matching text is highlighted with the HTML bold tag.",
"type": "string"
},
"value": {
"description": "The value of a suggested item.",
"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('getFieldAutoCompleteForQueryString', {
# Add required parameters here
})