GetCatalog

GetCatalog
MAIN
Rückgabewert
GridStruct	RET	GridStruct
Parameterliste
index	IN	RegularStringWithSingleContent
attribute	IN	RegularStringWithSingleContent
searchExpression	IN	LongStringWithSearchContent
sortedBy	IN	LongStringWithOptionalMultiContent
resultAmount	IN	RegularNumericValue
visibility	IN	Boolean
filteredWith	IN	LongString

Kurzbeschreibung:

Dieser Service liefert von einem bestimmten Index für diejenige Spalte, welche über den Parameter attribute definiert ist, deren Inhalte mit zugehöriger Häufigkeit. Dies gilt für alle Business-Objekte, welche der Search-Expression genügen. Die Treffer werden, sofern nichts anderes angegeben ist, nach Häufigkeit absteigend angezeigt.

Bemerkungen:

Gesucht wird nur in dem Mandanten, der via Kontext mitgegeben wird.

Ist resultAmount nicht angegeben, so werden fix maximal 1000 (DefaultResponseRows) Datensätze retourniert, ansonsten wird die Eingabe gegen 1'000'000 (Obergrenze des Parameter-Datentyps) validiert.

VD: <siehe Validator-Fehler>

(1): System.ServiceBus.GeneralServerError

(2): Search.IndexRepoActualizationFailed

(3): Search.FilteredWithSyntaxFailure

(4): Search.NoIndexRepoEntryForIndexName

(5): Search.NoActRdyIndexForIndexName

(6): Search.NoIndexDefHelperForIndexName

(7): Search.AttributeNotAvailable

(8): Search.AttributeNotSortable

(9): Search.AttributeNotFilterable

(10): Search.AttributeNotAccessible

(11): Search.InvalidSearchExpression

(12): Search.GetCatalogFailed

Erläuterungen:

(1) = Unerwarteter Fehler mit Beschreibung
(2) = IndexRepository-Aktualisierung fehlgeschlagen
(3) = Der Filter-Ausdruck ist ungültig
(4) = Kein IndexRepository-Eintrag für diesen Index
(5) = Kein verfügbarer Index mit diesem Namen
(6) = Der IndexDefinitionHelper ist nicht verfügbar
(7) = Das Attribut steht nicht zur Verfügung
(8) = Das Attribut ist kein Sortier-Attribut
(9) = Das Attribut ist kein Filter-Attribut
(10) = Das Attribut ist kein Rückgabe-Attribut
(11) = Ungültiger Suchausdruck
(12) = Fehler bei der eigentlichen Suche

Hinweis

index:
Ein Index, der physikalisch zur Verfügung stehen muss.

attribute:
Der Katalog wird über die Werte einer Index-Spalte erstellt, welche beim Aufruf unter attribute angegeben wird.
Diese Index-Spalte muss bei der Index-Konfiguration als Rückgabe- und Sortier-Attribut definiert worden sein.
Spezialfall: Mit einem * kann ohne Angabe einer Index-Spalte, die maximale Anzahl Treffer ermittelt werden.

searchExpression:
In der searchExpression können Wildcards verwendet und einzelne Suchausdrücke mit AND (Default) und OR verknüpft werden.

sortedby:
Bei sortedBy sind die beiden Sortierkriterien Value und Amount kombiniert zulässig. Die gültigen Sortierrichtungen sind asc, ascending (Default) wie auch desc, descending. Die String-Sortierung erfolgt nach en-US, CaseSensitive.

Wenn die Sortierung nicht korrekt scheint, hat dies den Grund, dass im ersten Schritt sortiert und im zweiten Schritt Daten überschrieben werden. Dies ist kein Fehlverhalten des Service, sondern bedeutet lediglich, dass die CatItems (noch) nicht konzeptgetreu abgefüllt wurden.

resultAmount: 
Dieser Parameter gibt an, wieviele Datensätze retourniert werden sollen.

flteredWith:
Die Filterung kann auf allen Spalten erfolgen, welche vorgängig als filterbar definiert wurden. Gefiltert wird in aller Regel über eine Kombination von Ausdrücken der Art (Spalte Operator Wert). 
Die String-Filterung erfolgt normalerweise Case-Insensitiv. Case-Sensitiv gefiltert werden kann über spezielle Operatoren.

resultAttributes:
Als Resultat werden stets die beiden Spalten Value und Amount retourniert. 
Spezialfall: Im Fall attribute * wird als Value ein * und als Amount die Gesamt-Trefferzahl retourniert.

Services

GetCatalog

Hinweis