sanitiseJqlQueries
Sanitize JQL queries
Details
- Method:
POST - Path:
/rest/api/3/jql/sanitize - Operation ID:
sanitiseJqlQueries
Parameters
{
"queries": {
"description": "The list of JQL queries to sanitize. Must contain unique values. Maximum of 20 queries.",
"required": true,
"location": "body",
"type": "array"
}
}Response Schema
{
"additionalProperties": false,
"description": "The sanitized JQL queries for the given account IDs.",
"properties": {
"queries": {
"description": "The list of sanitized JQL queries.",
"items": {
"additionalProperties": false,
"description": "Details of the sanitized JQL query.",
"properties": {
"accountId": {
"description": "The account ID of the user for whom sanitization was performed.",
"maxLength": 128,
"nullable": true,
"type": "string"
},
"errors": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorCollection"
}
],
"description": "The list of errors."
},
"initialQuery": {
"description": "The initial query.",
"type": "string"
},
"sanitizedQuery": {
"description": "The sanitized query, if there were no errors.",
"nullable": true,
"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('sanitiseJqlQueries', {
# Add required parameters here
})