# \JqlApi
All URIs are relative to *https://your-domain.atlassian.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_auto_complete**](JqlApi.md#get_auto_complete) | **GET** /rest/api/2/jql/autocompletedata | Get field reference data
[**get_field_auto_complete_for_query_string**](JqlApi.md#get_field_auto_complete_for_query_string) | **GET** /rest/api/2/jql/autocompletedata/suggestions | Get field auto complete suggestions
[**migrate_queries**](JqlApi.md#migrate_queries) | **POST** /rest/api/2/jql/pdcleaner | Convert user identifiers to account IDs in JQL queries
[**parse_jql_queries**](JqlApi.md#parse_jql_queries) | **POST** /rest/api/2/jql/parse | Parse JQL query
## get_auto_complete
> models::JqlReferenceData get_auto_complete()
Get field reference data
Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ) and [Advanced searching - functions reference](https://confluence.atlassian.com/x/hgORLQ), 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](#permissions) required:** None.
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::JqlReferenceData**](JQLReferenceData.md)
### Authorization
[OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_field_auto_complete_for_query_string
> models::AutoCompleteSuggestions get_field_auto_complete_for_query_string(field_name, field_value, predicate_name, predicate_value)
Get field auto complete suggestions
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](#permissions) required:** None.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**field_name** | Option<**String**> | The name of the field. | |
**field_value** | Option<**String**> | The partial field item name entered by the user. | |
**predicate_name** | Option<**String**> | The name of the [ CHANGED operator predicate](https://confluence.atlassian.com/x/hQORLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED) for which the suggestions are generated. The valid predicate operators are *by*, *from*, and *to*. | |
**predicate_value** | Option<**String**> | The partial predicate item name entered by the user. | |
### Return type
[**models::AutoCompleteSuggestions**](AutoCompleteSuggestions.md)
### Authorization
[OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## migrate_queries
> models::ConvertedJqlQueries migrate_queries(jql_personal_data_migration_request)
Convert user identifiers to account IDs in JQL 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](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/). **[Permissions](#permissions) required:** Permission to access Jira.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**jql_personal_data_migration_request** | [**JqlPersonalDataMigrationRequest**](JqlPersonalDataMigrationRequest.md) | | [required] |
### Return type
[**models::ConvertedJqlQueries**](ConvertedJQLQueries.md)
### Authorization
[OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## parse_jql_queries
> models::ParsedJqlQueries parse_jql_queries(jql_queries_to_parse, validation)
Parse JQL query
Parses and validates JQL queries. Validation is performed in context of the current user. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**jql_queries_to_parse** | [**JqlQueriesToParse**](JqlQueriesToParse.md) | | [required] |
**validation** | Option<**String**> | 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. | |[default to strict]
### Return type
[**models::ParsedJqlQueries**](ParsedJqlQueries.md)
### Authorization
[OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)