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:
fieldNameto get a list of all values for the field.fieldNameandfieldValueto get a list of values containing the text infieldValue.fieldNameandpredicateNameto get a list of all predicate values for the field.fieldName,predicateName, andpredicateValueto get a list of predicate values containing the text inpredicateValue.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters? | { fieldName?: string; fieldValue?: string; predicateName?: string; predicateValue?: string; } | - |
parameters.fieldName? | string | The name of the field. |
parameters.fieldValue? | string | The partial field item name entered by the user. |
parameters.predicateName? | string | The name of the CHANGED operator predicate for which the suggestions are generated. The valid predicate operators are by, from, and to. |
parameters.predicateValue? | string | The partial predicate item name entered by the user. |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; results?: object[]; }>