JQL

Parse JQL query

Parses and validates JQL queries.

Validation is performed in context of the current user.

This operation can be accessed anonymously.

Permissions required: None.

post/rest/api/2/jql/parse

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/jql/parse
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: read:jira-work)
    • none

Query parameters

validation'strict' | 'warn' | 'none' required

How to validate the JQL query and treat the validation results. Validation options include:

  • strict Returns all errors. If validation fails, the query structure is not returned.
  • warn Returns all errors. If validation fails but the JQL query is correctly formed, the query structure is returned.
  • none No validation is performed. If JQL query is correctly formed, the query structure is returned.

Request body

queriesstring[] required

A list of queries to parse.

Response

Returned if the request is successful.

Changes

No recorded changes to this operation across all 26 revisions of this API.