org.everit.atlassian.restclient.jiracloud.v3.api

Class JqlApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.JqlApi

public class JqlApi
extends Object

Constructor Summary

Constructors

Constructor and Description
JqlApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<JQLReferenceData>	getAutoComplete(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get field reference data Returns reference data for JQL searches.
io.reactivex.Single<AutoCompleteSuggestions>	getFieldAutoCompleteForQueryString(Optional<String> fieldName, Optional<String> fieldValue, Optional<String> predicateName, Optional<String> predicateValue, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get field auto complete suggestions Returns the JQL search auto complete suggestions for a field.
io.reactivex.Single<ConvertedJQLQueries>	migrateQueries(JQLPersonalDataMigrationRequest jqLPersonalDataMigrationRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) 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.
io.reactivex.Single<ParsedJqlQueries>	parseJqlQueries(JqlQueriesToParse jqlQueriesToParse, Optional<String> validation, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Parse JQL query Parses and validates JQL queries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JqlApi

public JqlApi(org.everit.http.restclient.RestClient restClient)

Method Detail

getAutoComplete

public io.reactivex.Single<JQLReferenceData> getAutoComplete(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

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:

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<JQLReferenceData>

getFieldAutoCompleteForQueryString

public io.reactivex.Single<AutoCompleteSuggestions> getFieldAutoCompleteForQueryString(Optional<String> fieldName,
                                                                                       Optional<String> fieldValue,
                                                                                       Optional<String> predicateName,
                                                                                       Optional<String> predicateValue,
                                                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

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:

fieldName - The name of the field. (optional)

fieldValue - The partial field item name entered by the user. (optional)

predicateName - 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*. (optional)

predicateValue - The partial predicate item name entered by the user. (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<AutoCompleteSuggestions>

migrateQueries

public io.reactivex.Single<ConvertedJQLQueries> migrateQueries(JQLPersonalDataMigrationRequest jqLPersonalDataMigrationRequest,
                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

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:

jqLPersonalDataMigrationRequest - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<ConvertedJQLQueries>

parseJqlQueries

public io.reactivex.Single<ParsedJqlQueries> parseJqlQueries(JqlQueriesToParse jqlQueriesToParse,
                                                             Optional<String> validation,
                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

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:

jqlQueriesToParse - (required)

validation - 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. (optional, default to strict)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<ParsedJqlQueries>