前のトピック: getDecisionTrees

次のトピック: getDocument

getDocumentsByIDs

getDocumentsByIDsメソッドでは以下のパラメータを使用します。

パラメータ

説明

SID

Integer

ログインにより取得したセッションを指定します。

docIds

String

取得するドキュメントIDをカンマ区切りリストで指定します。

propertyList

String

情報を取得するデータベース フィールドをカンマ区切りリストで指定します。 propertyListパラメータに関わらず、常に以下のフィールドが返されます。

  • ID
  • DOC_TYPE_ID
  • BU_RESULT

sort By

String

結果の並べ替えに使用するデータベース フィールドを指定します。 デフォルトは ID ですが、複数の並べ替えフィールドを指定することはできません。 別のフィールドを指定した場合は、そのフィールドで並べ替えられてから、常に ID での並べ替えが実行されます。

descending

Boolean

結果を降順で並べ替えるかどうかを指定します。

説明

情報を取得するドキュメントIDを渡して、1つ以上のドキュメントに関する情報を取得します。 このメソッドは通常、faq()またはsearch()メソッドをコールした後に使用します。 パフォーマンスを向上するため、これらのメソッドは、ユーザ定義のドキュメント セットの詳細情報のみを取得します。 残りのドキュメントについてはIDのみが返されます。 たとえば、[先頭]、[戻る]、[次へ]、[最後]といったリンクをクリックしてページ間を移動できるようにセットアップできます。 次のドキュメント セットを取得する場合は、getDocumentsByIDs()メソッドを使用できます。

戻り値

<UDSObjectList>ノード。ノード内に以下のセクションが返されます。

<UDSObject>ノード。ノード内に、ナレッジ ドキュメントを説明する<Attributes>ノードを含みます。

getDocumentsByIDs()のdocIdsパラメータには、これと同じ形式でIDを渡す必要があります。