Metodi dei servizi Web › Gestione della conoscenza › Metodi generali di Gestione della conoscenza › faq

Argomento precedente: Metodi generali di Gestione della conoscenza

Argomento successivo: search

faq

I parametri seguenti sono validi per il metodo faq:

Parametro

Tipo

Descrizione

SID

Numero intero

Identifica la sessione recuperata dall'accesso.

categoryIds

Stringa

Identifica l'ID di categoria utilizzato per eseguire il metodo faq. Utilizzare 1 per la categoria principale.

Nota: sono supportati più id, ad esempio, "1, 2, 3".

resultSize

Numero intero

Identifica il numero di documenti per cui si desidera recuperare informazioni dettagliate. Per i documenti rimanenti, vengono restituiti solo i relativi ID. È possibile accedere alle informazioni dettagliate di questi documenti in seguito utilizzando il metodo getDocumentsByIDs(). L'impostazione predefinita è 10.

propertyList

Stringa

Identifica l'elenco di valori separato da virgole di campi di database da cui si desidera recuperare le informazioni. I campi seguenti vengono sempre restituiti, indipendentemente dal parametro propertyList:

  • ID
  • DOC_TYPE_ID
  • BU_RESULT

sortBy

Stringa

Identifica il campo di database che si desidera utilizzare per ordinare i risultati. Più campi di ordinamento non sono supportati. Il valore predefinito è BU_RESULT, che indica che la classificazione faq esegue l'ordinamento. Se id è utilizzato come ordinamento secondario, ordina sempre i risultati.

descending

Boolean

Identifica un indicatore disponibile per l'ordinamento decrescente dei risultati.

whereClause

Stringa

Utilizzare questo parametro per aggiungere la propria ‘clausola where SQL’ per il filtraggio dei risultati della ricerca.

maxDocIds

Numero intero

Identifica il numero massimo di ID dei documenti che deve essere restituito (il valore predefinito è 100).

Ad esempio, se per il parametro resultSize si specifica 10 e per il parametro maxDocIds 50, se nel database sono presenti 100 documenti corrispondenti, per 10 di essi verranno recuperate le informazioni dettagliate e per 40 verranno restituiti gli ID. I 50 documenti rimanenti non vengono restituiti.

Descrizione

Utilizzato per eseguire una ricerca faq. I documenti vengono recuperati in base all'ID di categoria passato. Viene restituito qualsiasi documento incluso in questa categoria o in qualsiasi sottocategoria. Per migliorare le prestazioni, questi metodi restituiscono solo informazioni dettagliate su un insieme di documenti definito dall'utente, che viene controllato tramite il parametro resultSize. I documenti rimanenti restituiscono solo i propri ID. Utilizzando questo metodo, è possibile ad esempio impostare un meccanismo di paging in cui l'utente può fare clic sui collegamenti ‘In alto’, ‘Precedente’, ‘Successivo’ e ‘In basso’. Quando si deve recuperare l'insieme successivo di informazioni, è possibile utilizzare il metodo getDocumentsByIDs(). Viene restituito il numero massimo di 100 ID.

Valore restituito

Un nodo <UDSObjectList> con le sezioni seguenti:

Nodo <UDSObject> dalla sezione relativa alla descrizione del nodo <UDSObject> di questo capitolo. È presente un nodo <UDSObject> con tutte le proprietà per i primi n documenti che il metodo trova quando il valore di n è uguale al valore del parametro resultSize.

Ad esempio, se il parametro resultSize è 10, il parametro maxDocIDs è 50 e il metodo trova 100 documenti, vi saranno 10 nodi <UDSObject> con nodi <Attributes> nella prima sezione di <UDSObject> con informazioni dettagliate sull'attributo ottenute dal parametro propertyList e 40 nodi <UDSObject> con il solo ID <Attributes> nella sezione seguente. Per recuperare le informazioni dettagliate sull'ID <AttrName> per i documenti 11-20, è necessario eseguire una chiamata al metodo getDocumentsByIDs() e passarvi gli ID ottenuti da <AttrValue>.