Skip to content

Function: getFieldAutoCompleteForQueryString() ​

ts
function getFieldAutoCompleteForQueryString(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  results?: object[];
}>;

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

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.

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ fieldName?: string; fieldValue?: string; predicateName?: string; predicateValue?: string; }-
parameters.fieldName?stringThe name of the field.
parameters.fieldValue?stringThe partial field item name entered by the user.
parameters.predicateName?stringThe name of the CHANGED operator predicate for which the suggestions are generated. The valid predicate operators are by, from, and to.
parameters.predicateValue?stringThe partial predicate item name entered by the user.
options?RequestOptions-

Returns ​

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