NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: For HPCDATAMGM-1142: Deleted compoundQueryType row, bc dm_query_dataobject is only for data files.

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 should at least have one simple query that could be part of a list of queries or a list of nested compound queries.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

...

  • : This operator combines multiple queries. Valid values are as follows:
    • AND
    • OR
  • Filtering criteria: These can be a list of one or more simple queries, a list of one or more nested compound queries, or both. 
  • Additional optional indicators: 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.compoundQueryTypeIn a saved query, this indicator specifies the query type. Valid values are as follows:
  • COLLECTION
  • DATA_OBJECT