faq

Méthodes de services Web › Gestion des connaissances › Méthodes générales des Gestion des connaissances › faq

faq

Les paramètres suivants s’appliquent à la méthode faq :

Paramètre	Type	Description
SID	Nombre entier	Identifie la session extraite depuis la connexion.
categoryIds	Chaîne	Identifie l’ID de catégorie utilisé pour effectuer un calcul faq. Utilisez 1 pour la catégorie racine. Remarque : Plusieurs ID sont pris en charge, par exemple, 1, 2, 3.
resultSize	Nombre entier	Identifie le nombre de documents pour lesquels vous souhaitez extraire des informations détaillées. Seuls les ID des autres documents sont renvoyés. Vous pouvez accéder ultérieurement à ces informations détaillées à l’aide de la méthode getDocumentsByIDs(). La valeur par défaut est 10.
propertyList	Chaîne	Identifie la liste de données séparées par des virgules des champs de la base de données dont vous souhaitez extraire des informations. Les champs suivants sont toujours renvoyés, quel que soit le paramètre propertyList : id DOC_TYPE_ID BU_RESULT
sortBy	Chaîne	Identifie le champ de la base de données que vous souhaitez utiliser pour trier les résultats. Les champs à tri multiple ne sont pas pris en charge. La valeur par défaut est BU_RESULT, ce qui signifie que l’évaluation FAQ la trie. Lorsque l'identificateur est utilisé comme un tri secondaire, il trie toujours les résultats.
descending	Booléen	Identifie un indicateur disponible pour trier les résultats par ordre décroissant.
whereClause	Chaîne	Utilisez ce paramètre pour ajouter votre propre clause SQL Where et filtrer les résultats de la recherche.
maxDocIds	Nombre entier	Identifie le nombre maximum d’ID de document à renvoyer (la valeur par défaut est 100). Par exemple, si vous définissez resultSize sur 10 et maxDocIds sur 50, s’il existe 100 documents correspondants dans la base de données, les informations détaillées de 10 de ces documents sont extraites, et les ID de 40 de ces documents sont renvoyés. Les 50 résultats restants ne sont pas renvoyés.

Description

Permet d'effectuer une recherche faq. Les documents sont extraits en fonction de l’ID de catégorie transmis. Tous les documents résidant dans cette catégorie ou ses sous-catégories sont renvoyés. Pour une performance optimale, ces méthodes extraient uniquement les informations détaillées d’un ensemble de documents défini par l’utilisateur et contrôlé via le paramètre resultSize. Les autres documents renvoient uniquement leur ID. Par exemple, cette méthode permet de configurer une méthode de pagination qui met des liens Haut, Précédente, Suivante et Bas à la disposition de l’utilisateur. Pour extraire les informations suivantes, vous pouvez utiliser la méthode getDocumentsByIDs(). Le nombre maximal d’ID renvoyés est de 100.

Eléments renvoyés

Un nœud <UDSObjectList> avec les sections suivantes :

Le nœud <UDSObject> de la section Description du nœud <UDSObject> du présent chapitre. Il existe un nœud <UDSObject> contenant toutes les propriétés données des n premiers documents que la méthode trouve lorsque n est égal au paramètre resultSize.

Par exemple, si le paramètre resultSize est défini sur 10, le paramètre maxDocIDs sur 50 et que la méthode trouve 100 documents, il existe alors 10 <UDSObject> avec les nœuds <Attributes> dans la première section <UDSObject> ayant les informations d’attribut détaillées du paramètre propertyList, et 40 nœuds <UDSObject> avec des ID <Attributes> uniquement dans la section suivante. Si vous souhaitez extraire des informations détaillées sur l’ID <AttrName> pour les documents numérotés de 11 à 20, vous devez appeler la méthode getDocumentsByIDs() et lui transmettre les ID de <AttrValue>.