getDocumentsByIDs

Web Services Methods › Knowledge Management › Knowledge Management General Methods › getDocumentsByIDs

getDocumentsByIDs

The following parameters apply to the getDocumentsByIDs method:

Parameter	Type	Description
SID	Integer	Identifies the session retrieved from logging in.
docIds	String	Identifies the comma-separated list of document IDs to retrieve.
propertyList	String	Identifies the comma-separated list of database fields for which you want to retrieve information. The following fields are always returned, regardless of the propertyList parameter: id DOC_TYPE_ID BU_RESULT
sort By	String	Identifies the database field that you want to use for sorting the results. The default is id, but multiple sort fields are not supported. If you specify another field, id as a secondary sort always sorts the results.
descending	Boolean	Identifies an indicator available for sorting the results in descending order.

Description

Retrieves information on one or more documents by passing the document IDs for which you want to retrieve information. This is usually used after calling the faq() or search() methods. In order to improve performance, these methods only retrieve detailed information on a user-defined set of documents. The rest of the documents return their IDs only. For example, you can set up a paging mechanism, where the user can click on Top, Previous, Next, and Bottom links. When you need to retrieve the next set of information, you can use the getDocumentsByIDs() method.

Returns

A <UDSObjectList> node with the following section:

<UDSObject> nodes with requested <Attributes> nodes describing Knowledge Document

You should pass the IDs into the getDocumentsByIDs() docIds parameter in this same format.