browseResults

The browserequest results object consists of a browseResults element and its children. The XML response contains a representation of the input item set, which may include a set of index items and a set of children item sets. The child item sets use the same XML representation, and can therefore also contain information about their index items and children item sets.

The browse response contains information about the index item which allows an application to construct a View Item request to view a browsed item, as described in the viewInContext element section.

Note that in this query type, the actual document of the result is located in the browseResults/category/documents element. This structure differs from that of other query response types.

The browseResults element is the root element of a browse response, and has the following attributes, which correspond to attributes of the browse element:

Attributes

Description

QUID

Query identifier.

ancestry

Whether ancestry of the browsed document set is returned.

maxDepth

Maximum depth to browse from starting document set. 0 = infinite.

maxSets

Maximum number of descendent document sets to return. 0 = infinite.

maxSize

Returned document sets must be smaller than or equal to this value.

minSize

Returned document sets must be larger than or equal to this value.

maxDesc

Maximum number of descendent document sets to return under each child of the input set.

maxDocs

Maximum number of documents to return across all sets.

maxDocsPerSet

Maximum number of documents to return per set.

docDepth

Maximum depth from starting set to return documents.

constrDocCounts

Maximum total size of document sets that can have its constraint-based value computed. A value of true means 100,000 and a value of false means 0.

docSort

Secondary sort method to use on final result groups.

docSortOrder

Sort order of final result groups.

docSortProp

If docSort is strpropr or numprop, this attribute holds the name of the property to use for sorting.

docSortPropDefault

If docSort is strpropr or numprop, this attribute holds the default value for the property.

setSort

Descendent document set sort order.

recurseDocuments

Whether returned documents can be from descendents of a returned set.

refineMax

Maximum number of refinements.

refineTop

Number of values to return per refinement.

refineMin

Minimum size of a refinement (in terms of values).

pageNum

Constrain the index items to this page.

pageSize

Number of index items per page.

parent

Parent of input document set.

A browseResults element contains the following elements:

  • documentSets

  • input

  • category

 
loading table of contents...