Function parseJqlQueries

parseJqlQueries(
    client: Client,
    parameters: {
        queries: string[];
        validation: "none" | "strict" | string & {} | "warn";
    },
    options?: RequestOptions,
): Promise<
    {
        queries: {
            errors?: string[];
            query: string;
            structure?: {
                orderBy?: {
                    fields: {
                        direction?: (...)
                        | (...)
                        | (...)
                        | (...);
                        field: {
                            encodedName?: ...;
                            name: ...;
                            property?: ...;
                            [key: ...]: ...;
                        };
                        [key: string]: unknown;
                    }[];
                    [key: string]: unknown;
                };
                where?: JqlQueryClause;
                [key: string]: unknown;
            };
            warnings?: string[];
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Parses and validates JQL queries.

Validation is performed in context of the current user.

This operation can be accessed anonymously.

Permissions required: None.
Parameters
- client: Client
- parameters: { queries: string[]; validation: "none" | "strict" | string & {} | "warn" }
  - queries: string[]
    
    A list of queries to parse.
  - validation: "none" | "strict" | string & {} | "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.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        queries: {
            errors?: string[];
            query: string;
            structure?: {
                orderBy?: {
                    fields: {
                        direction?: (...)
                        | (...)
                        | (...)
                        | (...);
                        field: {
                            encodedName?: ...;
                            name: ...;
                            property?: ...;
                            [key: ...]: ...;
                        };
                        [key: string]: unknown;
                    }[];
                    [key: string]: unknown;
                };
                where?: JqlQueryClause;
                [key: string]: unknown;
            };
            warnings?: string[];
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
- Defined in src/cloud/api/jql.ts:118

Function parseJqlQueries

Parameters

queries: string[]

validation: "none" | "strict" | string & {} | "warn"

Settings