vtx.GetAutoCompleteResult

This job returns auto-complete suggestions from the full-text engine for a search term. Typically used in the search input field to display live suggestions.

This job is not described in the official enaio® documentation but is listed as known in the VTX engine overview’s "Undocumented Endpoints" section. This description was reconstructed from the call code of the enaio-jobs-custom template.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Reserved; always pass 0.

Term

STRING

Yes

Input term for which suggestions are to be returned.

[ObjectTypes]

STRING

No

Restrict suggestions to specific object types. Format: separator-separated list of numeric object type IDs (the separator is passed through unchanged by the call code — typically , or ;).

2. Output Parameters

Name Type Dependency Description

Result

STRING

—

Suggestion list in the format term1,score1;term2,score2;…. Individual hits are separated by ;; term and score are separated by ,.

3. Return Value

(INT): 0 = job successful, otherwise error code.

4. See Also

  • vtx.IsAutoCompleteEnabled — feature flag query (likewise officially undocumented)

  • vtx.GetSearchResult — actual full-text search