The category provides document count information, and contains query refinements, documents, and additional categories.

Attributes

Description

_path

Path name of document set.

label

Optional display label for document set.

_id

Topic ID, if the document set represents a topic.

nUniqueDocuments

Total number of unique documents under this document set and all descendents.

nTotalDocuments

Total number of documents under this document set and all descendents.

nDisplayedDocuments

Total documents returned under this document set, with respect to constraints and settings.

nDocuments

Total documents immediately under this document set.

nChildren

Number of child sets immediately under this document set.

nTotalChildren

Total number of descendent sets under this document set and its child sets.

nDisplayedChildren

Number of returned descendents with respect to constraints and settings.

All of the child elements of a category are collections of simple single elements.

Child Elements

Description

refinements

Has refinement elements as children.

documents

Has document elements as children. These are the same as those described in the answer/response/document section.

children

Has additional category elements as children.

 
loading table of contents...