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.

...

A simple query consists of the following parts:

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

When you perform a query, the system requires it in the context of a compoundQuery element, even if it is only one simple query. A A compound query 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 A compound query should at least have one simple query that could be part of a list of queries or a list of nested compound queries.

...

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

IndicatorDescription
detailedResponseBy default, the search returns only the path of matched resulted collections. If
“detailedResponse=true”, this
the query specifies true for the detailedResponse indicator, the service returns collections with metadata.
page
Ask for a specific page of results.
By default, the query returns the first 100 results in page 1, the second 100 in page 2, and so on. If
omitted
the query omits the page indicator, the
query
service fetches page 1. If the query specifies a number for the page indicator, the service returns the specified page of results.
totalCountIf
you set this indicator to ‘true’, this
the query specifies true for the totalCount indicator, the service returns a total count of collections matching the query regardless of the query limit and page. The default for this indicator is false, so if
you omit
the query omits it,
this
the service does not return a total count.