faq

Web-Service-Methoden › Knowledge Management › Knowledge Management – Allgemeine Methoden › faq

faq

Die folgenden Parameter gelten für die Methode „faq“:

Parameter	Typ	Beschreibung
SID	Ganzzahl	Gibt die Sitzung an, die durch die Anmeldung abgerufen wurde.
categoryIds	Zeichenfolge	Gibt die zur Durchführung von „faq“ verwendete Kategorie-ID an. Verwenden Sie „1“ für die „Stamm“-Kategorie. Hinweis: Es werden mehrere IDs unterstützt, z. B. "1, 2, 3".
resultSize	Ganzzahl	Gibt die Anzahl der Dokumente an, aus denen detaillierte Informationen abgerufen werden sollen. Für alle anderen Dokumente werden lediglich die IDs zurückgegeben. Auf ausführliche Informationen zu diesen Dokumenten kann zu einem späteren Zeitpunkt anhand der Methode „getDocumentsByIDs()“ zugegriffen werden. Der Standardwert ist 10.
propertyList	Zeichenfolge	Gibt die durch Kommas getrennte Liste der Datenbankfelder an, aus denen Informationen abgerufen werden sollen. Die folgenden Felder werden unabhängig vom Parameter „propertyList“ immer zurückgegeben: ID DOC_TYPE_ID BU_RESULT
sortBy	Zeichenfolge	Gibt das Datenbankfeld an, das Sie zum Sortieren der Ergebnisse verwenden möchten. Mehrfache Sortierfelder werden nicht unterstützt. Der Standardwert ist BU_RESULT, bei dem die Sortierung durch die FAQ-Einstufung erfolgt. Wenn die ID als sekundäres Sortierungskriterium verwendet wird, werden die Ergebnisse immer sortiert.
descending	Boolescher Wert	Gibt einen für die Sortierung der Ergebnisse in absteigender Reihenfolge verfügbaren Indikator an.
whereClause	Zeichenfolge	Verwenden Sie dies, um eine eigene SQL-Where-Klausel zum Filtern der Suchergebnisse hinzuzufügen.
maxDocIds	Ganzzahl	Gibt die maximale Anzahl an zurückzugebenden Dokument-IDs an (der Standardwert ist 100). Wenn beispielsweise für „resultSize“ der Wert 10 und für „maxDocIds“ der Wert 50 festgelegt wird und 100 übereinstimmende Dokumente in der Datenbank vorhanden sind, dann werden für 10 von ihnen detaillierte Informationen abgefragt, und für weitere 40 lediglich die IDs zurückgegeben. Die übrigen 50 werden nicht zurückgegeben.

Beschreibung

Verwenden Sie dies zur Durchführung von FAQ-Suchvorgängen. Dokumente werden auf Grundlage der übergebenen Kategorie-ID abgerufen. Es werden alle Dokumente zurückgegeben, die in dieser Kategorie oder einer beliebigen Unterkategorie vorhanden sind. Zur Leistungsverbesserung werden mit diesen Methoden nur detaillierte Informationen über einen benutzerdefinierten Satz von Dokumenten abgerufen, was anhand des Parameters „resultSize“ gesteuert wird. Für die verbleibenden Dokumente werden lediglich die IDs zurückgegeben. Mit dieser Methode können Sie z. B. einen Seitennavigationsmechanismus einrichten, bei dem Benutzer auf Verknüpfungen wie „Seitenanfang“, „Zurück“, „Vorwärts“ und „Seitenende“ klicken können. Wenn der nächste Informationssatz abgerufen werden soll, können Sie die Methode „getDocumentsByIDs()“ verwenden. Es werden maximal 100 IDs zurückgegeben.

Rückgabe

Ein <UDSObjectList>-Knoten mit den folgenden Abschnitten:

Ein <UDSObject>-Knoten aus dem Abschnitt über die <UDSObject>-Knotenbeschreibung in diesem Kapitel. Es ist ein <UDSObject>-Knoten mit allen angegebenen Eigenschaften für die ersten n mit der Methode gefundenen Dokumente vorhanden, wobei n dem Parameter „resultSize“ entspricht.

Wenn beispielsweise der Parameter „resultSize“ den Wert 10 und „maxDocIDs“ den Wert 50 hat und die Methode 100 Dokumente findet, dann werden für 10 <UDSObject>-Knoten mit <Attributes>-Knoten im ersten <UDSObject>-Abschnitt detaillierte Attributinformationen aus dem Parameter „propertyList“ sowie für 40 <UDSObject>-Knoten nur die ID-<Attributes> im nächsten Abschnitt abgerufen. Sollen detaillierte ID-<AttrName>-Informationen für Dokumente mit den Nummern 11–20 abgerufen werden, muss die Methode „getDocumentsByIDs()“ aufgerufen und ihr die IDs aus <AttrValue> übergeben werden.