vtx.GetSearchResult

This job performs a full-text search via the VTX engine and returns hits with score, optional preview and optional facet aggregations. Request and response are exchanged as JSON.

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.

Query

BASE64

Yes

Search request as a UTF-8-encoded JSON document (schema below).

1.1. Query JSON schema

{
  "searchString": "<search term>",
  "maxHits": 50,
  "restrictions": {
    "objectTypeIds": [<int>, ...],
    "prefetchedIds": [<int>, ...],
    "locations": [
      { "objectTypeId": <int>, "objectId": <int> },
      ...
    ]
  },
  "flags": {
    "includePreview": true,
    "includeFacets": true
  },
  "aggregations": {
    "filter": {
      "<facetKey>": ["<value>", ...]
    }
  },
  "queryCatalogueLocale": "<locale tag, e.g. de_DE>"
}
Field Type Required Description

searchString

string

Yes

Search term; must not be empty.

maxHits

int

Yes

Upper bound of hits; call-code default 50.

restrictions.objectTypeIds

int[]

Yes

List of allowed object types; at least one entry.

restrictions.prefetchedIds

int[]

No

Pre-restricted object IDs (re-ranking instead of search).

restrictions.locations

obj[]

No

List of {objectTypeId,objectId} pairs to restrict to specific parents (folders / registers).

flags.includePreview

bool

No

Generate snippet previews.

flags.includeFacets

bool

No

Compute facet aggregations alongside hits.

aggregations.filter

map

No

Active facet filters per facet key.

queryCatalogueLocale

string

No

Language for catalog lookups.

2. Output Parameters

Name Type Dependency Description

Result

BASE64

—

Response as UTF-8-encoded JSON.

2.1. Result JSON schema

{
  "totalHits": <int>,
  "hits": [
    {
      "objectTypeId": <int>,
      "objectId": <int>,
      "score": <number>,
      "previewSnippet": "<text>"
    },
    ...
  ],
  "aggregations": {
    "<facetKey>": {
      "buckets": [
        { "key": "<value>", "doc_count": <int> },
        ...
      ]
    }
  }
}

3. Return Value

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

4. See Also

  • vtx.GetAutoCompleteResult — live suggestions for the search input

  • vtx.OpenObjectQuery — alternative request variant via object selector

  • vtx.IsFacetSearchEnabled / vtx.IsPreviewEnabled — feature flag queries (likewise officially undocumented)