Skip to content

Function: parseJqlQueries()

ts
function parseJqlQueries(client, parameters): Promise<{
[key: string]: unknown;
  queries: object[];
}>;

Defined in: src/cloud/api/jql.ts:110

Parses and validates JQL queries.

Validation is performed in context of the current user.

This operation can be accessed anonymously.

Permissions required: None.

Parameters

ParameterTypeDescription
clientClient-
parameters{ queries: string[]; validation: "none" | "strict" | string & object | "warn"; }-
parameters.queriesstring[]A list of queries to parse.
parameters.validation"none" | "strict" | string & object | "warn"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.

Returns

Promise<{ [key: string]: unknown; queries: object[]; }>