NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

If your user account has the Read, Write, or Own permission level on a collection or data file in DME, you can search for that data. You can perform a simple query, or you can combine multiple simple queries into a compound query.

A simple query consists of the following parts:

  • attribute or attributeMatch
  • value
  • operator
  • levelFilter (optional)

When you perform a query, the system requires it in the context of a compoundQuery element, even if it contains only one simple query. A compoundQuery element consists of the following parts:

  • Join operator
  • List of simple queries (filtering criteria)
  • List of compound queries (filtering criteria)
  • Additional optional indicators

A compoundQuery element should at least have one simple query that could be part of a list of queries or a list of nested compound queries.

You can use a join operator to combine multiple simple or compound queries (or both simple and compound). Valid values are as follows:

  • AND
  • OR

The following table describes the additional indicators to consider in your compoundQuery element:

IndicatorDescription
detailedResponseBy default, the search returns only the path of the collections or data files that match the query criteria. If the query specifies true for the detailedResponse indicator, the service returns paths with metadata.
pageBy default, the query returns the first 100 results in page 1, the second 100 in page 2, and so on. If the query omits the page indicator, the service fetches page 1. If the query specifies a number for the page indicator, the service returns the specified page of results.
totalCountIf the query specifies true for the totalCount indicator, the service returns a total count of collections or data files matching the query regardless of the query limit and page. The default for this indicator is false, so if the query omits it, the service does not return a total count.
compoundQueryType

In a saved query, this indicator specifies the query type. Valid values are as follows:

  • COLLECTION
  • DATA_OBJECT
  • No labels