Module jql_api

Enums

GetAutoCompleteError

struct for typed errors of method get_auto_complete

GetFieldAutoCompleteForQueryStringError

struct for typed errors of method get_field_auto_complete_for_query_string

MigrateQueriesError

struct for typed errors of method migrate_queries

ParseJqlQueriesError

struct for typed errors of method parse_jql_queries

Functions

get_auto_complete

Returns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields reference and Advanced searching - functions reference, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder. This operation can be accessed anonymously. Permissions required: None.

get_field_auto_complete_for_query_string

Returns the JQL search auto complete suggestions for a field. Suggestions can be obtained by providing: * fieldName to get a list of all values for the field. * fieldName and fieldValue to get a list of values containing the text in fieldValue. * fieldName and predicateName to get a list of all predicate values for the field. * fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue. This operation can be accessed anonymously. Permissions required: None.

migrate_queries

Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs. You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide. Permissions required: Permission to access Jira.

parse_jql_queries

Parses and validates JQL queries. Validation is performed in context of the current user. This operation can be accessed anonymously. Permissions required: None.