NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Revised based on observation after running API cURL query commands in UAT.

...

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

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

...

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