Tema anterior: Métodos generales de Gestión del conocimientoTema siguiente: buscar


faq

Los siguientes parámetros se aplican al método faq:

Parámetro

Tipo

Descripción

SID

Entero

Identifica la sesión recuperada del inicio de sesión.

categoryIds

Cadena

Identifica el ID de categoría utilizado para realizar la pregunta frecuente. Utilice 1 para la categoría "Raíz".

Nota: Se admiten varios ID; por ejemplo, "1, 2, 3".

resultSize

Entero

Identifica el número de documentos de los que desea recuperar información detallada. Para el resto de los documentos, sólo se devuelven los ID. Se puede acceder posteriormente a la información detallada de estos documentos mediante el método getDocumentsByIDs(). El valor predeterminado es 10.

propertyList

Cadena

Identifica la lista separada por comas de los campos de base de datos de los que desea recuperar información. Siempre se devuelven los campos siguientes, independientemente del parámetro propertyList:

  • ID
  • DOC_TYPE_ID
  • BU_RESULT

sortBy

Cadena

Identifica el campo de base de datos que desea utilizar para ordenar los resultados. No se admiten varios campos de ordenación. El valor predeterminado es BU_RESULT, lo que significa que la clasificación de preguntas frecuentes lo ordena. Cuando se utiliza ID como ordenación secundaria, siempre se ordenan los resultados.

descending

Boolean

Identifica un indicador disponible para ordenar los resultados en orden descendente.

whereClause

Cadena

Utilícelo para agregar su propia "cláusula Where SQL" para filtrar los resultados de la búsqueda.

maxDocIds

Entero

Identifica la cantidad máxima de ID de documentos que se deben devolver (el valor predeterminado es 100).

Por ejemplo, si el parámetro resultSize es 10, el parámetro maxDocIds es 50 y hay 100 documentos coincidentes en la base de datos, recuperará información detallada de 10 y sólo el ID de 40. No se devuelven los 50 restantes.

Descripción

Utilice este método para realizar una búsqueda de preguntas frecuentes. Los documentos se recuperan en función del ID de categoría introducido. Se devuelven todos los documentos que residen en dicha categoría o en cualquier subcategoría. Para mejorar el rendimiento, estos métodos sólo recuperan información detallada de un conjunto de documentos definido por el usuario, que se controla mediante el parámetro resultSize. El resto de los documentos sólo devuelven sus ID. Con este método, por ejemplo, puede configurar un mecanismo de paginación en el que el usuario pueda hacer clic en los vínculos "Inicio", "Anterior", "Siguiente" y "Fin". Si necesita recuperar el siguiente lote de información, puede utilizar el método getDocumentsByIDs(). Se devuelven un máximo de 100 ID.

Resultado

Un nodo <UDSObjectList> con las siguientes secciones:

Nodo <UDSObject> de la sección Descripción del nodo <UDSObject> de este capítulo. Existe un nodo <UDSObject> con todas las propiedades correspondientes a los primeros n documentos que el método encuentra, donde n equivale al parámetro resultSize.

Por ejemplo, si el parámetro resultSize es 10, el parámetro maxDocIDs es 50 y el método encuentra 100 documentos, habrá 10 <UDSObject> con nodos <Attributes> en la primera sección de <UDSObject> con información de atributos detallada del parámetro propertyList y 40 nodos <UDSObject> con sólo <Attributes> de ID en la siguiente sección. Si desea recuperar información detallada de <AttrName> de ID para los documentos numerados del 11 al 20, debe realizar una llamada al método getDocumentsByIDs() e introducir los ID desde <AttrValue>.