vtx.GetSearchResult

Dieser Job führt eine Volltext-Suche über die VTX-Engine aus und liefert Treffer mit Score, optionaler Vorschau und optional Facetten-Aggregationen zurück. Anfrage und Antwort werden als JSON ausgetauscht.

Der Job ist in der offiziellen enaio®-Doku nicht beschrieben, im VTX-Engine-Übersichts-Eintrag „Nicht dokumentierte Endpunkte" aber als bekannt aufgelistet. Diese Beschreibung wurde aus dem Aufruf-Code des enaio-jobs-custom-Templates rekonstruiert.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

Flags

INT

Ja

Reserviert; stets 0 übergeben.

Query

BASE64

Ja

Such-Anfrage als UTF-8-kodiertes JSON-Dokument (Schema siehe unten).

1.1. Query-JSON-Schema

{
  "searchString": "<Suchbegriff>",
  "maxHits": 50,
  "restrictions": {
    "objectTypeIds": [<int>, ...],
    "prefetchedIds": [<int>, ...],
    "locations": [
      { "objectTypeId": <int>, "objectId": <int> },
      ...
    ]
  },
  "flags": {
    "includePreview": true,
    "includeFacets": true
  },
  "aggregations": {
    "filter": {
      "<facetKey>": ["<value>", ...]
    }
  },
  "queryCatalogueLocale": "<Locale-Tag, z. B. de_DE>"
}
Feld Typ Pflicht Beschreibung

searchString

string

Ja

Suchterm; nicht leer.

maxHits

int

Ja

Obergrenze der Treffer; im Aufruf-Code Default 50.

restrictions.objectTypeIds

int[]

Ja

Liste der zulässigen Objekttypen; mindestens ein Eintrag.

restrictions.prefetchedIds

int[]

Nein

Vorab eingeschränkte Objekt-IDs (Re-Ranking statt Suche).

restrictions.locations

obj[]

Nein

Liste {objectTypeId,objectId}-Paare zur Einschränkung auf bestimmte Eltern (Ordner / Register).

flags.includePreview

bool

Nein

Snippet-Vorschauen erzeugen.

flags.includeFacets

bool

Nein

Facetten-Aggregationen mitberechnen.

aggregations.filter

map

Nein

Aktive Facetten-Filter pro Facetten-Key.

queryCatalogueLocale

string

Nein

Sprache für Katalog-Lookups.

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

Result

BASE64

—

Antwort als UTF-8-kodiertes 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. Rückgabe

(INT): 0 = Job erfolgreich, sonst Fehlercode.

4. Siehe auch

  • vtx.GetAutoCompleteResult — Live-Vorschläge zur Sucheingabe

  • vtx.OpenObjectQuery — alternative Anfrage-Variante über Objekt-Selektor

  • vtx.IsFacetSearchEnabled / vtx.IsPreviewEnabled — Feature-Flag-Abfragen (ebenfalls offiziell undokumentiert)