Atlassian: Parse JQL query

← Jql operations · Get started

Operation atlassian.parsejqlqueries

Provider route: POST /{cloudId}/rest/api/3/jql/parse. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["jql"]["parseJqlQueries"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.jql.parseJqlQueries(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.jql.parse_jql_queries(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
query	object	Required within parent	Additional keys: not allowed
query.validation	string	Required within parent	Default: strict One of: strict, warn, none
body	Model	Required within parent	Expand Parse JQL query — request body — body

Referenced models: Parse JQL query — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Parse JQL query — response body

Referenced models: Parse JQL query — response body

Schemas

12 more schemas are linked from the tables above, on the schema pages.

Parse JQL query — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	A list of JQL queries to parse. write Only: true Additional keys: not allowed
queries	array	Required within parent	A list of queries to parse. Minimum length: 1
queries[]	string	Each item	Minimum length: 1

Parse JQL query — response body

Field	Type	Presence	Description and constraints
$	object	Root	A list of parsed JQL queries.
queries	JSON	Optional
queries (anyOf 1)	array	Alternative	A list of parsed JQL queries. Minimum length: 1
queries (anyOf 1)[]	Model	Each item	Expand Parse JQL query — response body — queries A list of parsed JQL queries item
queries (anyOf 2)	null	Alternative

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item

Parse JQL query — response body — queries A list of parsed JQL queries item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a parsed JQL query. Minimum length: 1
errors	JSON	Optional
errors (anyOf 1)	array	Alternative	The list of syntax or validation errors. Unique items: true
errors (anyOf 1)[]	string	Each item
errors (anyOf 2)	null	Alternative
query	JSON	Optional
query (anyOf 1)	string	Alternative	The JQL query that was parsed and validated.
query (anyOf 2)	null	Alternative
structure	JSON	Optional
structure (anyOf 1)	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query The syntax tree of the query. Empty if the query was invalid.
structure (anyOf 2)	null	Alternative
warnings	JSON	Optional
warnings (anyOf 1)	array	Alternative	The list of warning messages Unique items: true
warnings (anyOf 1)[]	string	Each item
warnings (anyOf 2)	null	Alternative

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query

Field	Type	Presence	Description and constraints
$	object	Root	A parsed JQL query.
orderBy	JSON	Optional
orderBy (anyOf 1)	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query order By Details of the order-by JQL clause
orderBy (anyOf 2)	null	Alternative
where	JSON	Optional
where (anyOf 1)	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause
where (anyOf 2)	null	Alternative

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause, Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query order By Details of the order-by JQL clause

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause

Field	Type	Presence	Description and constraints
$	object	Root	A JQL query clause.
$ (anyOf 1)	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause clauses, operator
$ (anyOf 2)	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator
$ (anyOf 3)	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator, predicates
$ (anyOf 4)	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operator, predicates

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause clauses, operator, Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operator, predicates, Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator, Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator, predicates

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query order By Details of the order-by JQL clause

Field	Type	Presence	Description and constraints
$	object	Root	Details of the order-by JQL clause.
fields	JSON	Optional
fields (anyOf 1)	array	Alternative	The list of order-by clause fields and their ordering directives.
fields (anyOf 1)[]	Model	Each item	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query order By Details of the order-by JQL clause fields array item
fields (anyOf 2)	null	Alternative

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query order By Details of the order-by JQL clause fields array item

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause clauses, operator

Field	Type	Presence	Description and constraints
$	object	Root	A JQL query clause that consists of nested clauses. For example, `(labels in (urgent, blocker) OR lastCommentedBy = currentUser()). Note that, where nesting is not defined, the parser nests JQL clauses based on the operator precedence. For example, "A OR B AND C" is parsed as "(A OR B) AND C". See Setting the precedence of operators for more information about precedence in JQL queries.`
clauses	JSON	Optional
clauses (anyOf 1)	array	Alternative	The list of nested clauses.
clauses (anyOf 1)[]	Model	Each item	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause
clauses (anyOf 2)	null	Alternative
operator	JSON	Optional
operator (anyOf 1)	string	Alternative	The operator between the clauses. Known values: and, or, not
operator (anyOf 2)	null	Alternative

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator

Field	Type	Presence	Description and constraints
$	object	Root	A clause that asserts the current value of a field. For example, `summary ~ test`.
field	JSON	Optional
field (anyOf 1)	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator field encoded Name, name, property
field (anyOf 2)	null	Alternative
operand	JSON	Optional
operand (anyOf 1)	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause
operand (anyOf 2)	null	Alternative
operator	JSON	Optional
operator (anyOf 1)	string	Alternative	The operator between the field and operand. Known values: =, !=, >, <, >=, <=, in, not in, ~, ~=, is, is not
operator (anyOf 2)	null	Alternative

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause, Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator field encoded Name, name, property

Policy, approvals and errors

SDK function policy ID: atlassian.parsejqlqueries. Catalog operation: parsejqlqueries. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-work"]

Official provider source