Elements Available for Browsing Data Using Filters, Operators, and Functions

Element

Element Value

Description of the Element Value

queryId

The following values can be used to define the given parameter:

QueryType

This has a string value that is used to identify each query. The response for each query also has the same id.

Each query type can have one of the following values:

• Data

  Response is returned as a list of browseData structures. A string value as dataParam can be passed.

• Aggregate

  This is used to compute aggregate data on a desired result set . aggrType can be set to one of the following values

  • MAX

  • MIN

  • AVG

  • SUM

  • COUNT

• TopBottom

  For TopBottomParam, the count is number of items.

topBottomParam

topBottomParam can have one of the following values:

• FilteretedBrowseField

• count

• Ascending

aggregateParam

aggregateParam can have one of the following values:

• aggregateParam

  This is used to compute aggregate data on a desired result set . aggrType can be set to one of the following values

  • MAX

  • MIN

  • AVG

  • SUM

  • COUNT

• FilteretedBrowseField

• FilteretedBrowseField Group By

dataParam

dataParam can have one of the following values:

• fileFilteretedBrowseField

• browsePpging can further have the following values:

  • firstnode

  • SkipNode

  • Pagesize

Options

All options mentioned below are set to “false” by default. The behavior changes when they are set to “true”.

The description column describes the behavior when the value is set to "true".

showDeletedFiles

This parameter displays the deleted files along with existing files in the browse results.

restoreIndex

This parameter restores the index automatically, if it is not available in cache.

caseInsensitive

This parameter enforces a case insensitive search for case-sensitive platforms.

skipIndexRestore

This parameter ensures not to restore the index and displays partial or no results

includeMetadata

This parameter enables inclusion of troubleshooting folders in the browse results.

Troubleshooting folders include collect files or job specific metadata files of a file system.

whereClause

A query can have multiple where clauses .

For example:

<whereClause> <criteria dataOperator="IN" field="ModifiedDate"> <values val="thisMonth"/> </criteria> </whereClause>