Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The request body for all the Dataqueries endpoint has "query" field under which values of facets for filtering can be plugged in. While the "query" field is common for all the endpoints, the
/species/observations dataqueries endpoint has two more fields namely, "page_number" and "page_size".

...

  • "dataset": ["dataset-url-1", "dataset-url-2", ...]

  • “date"date_from": "2020-01-01"

  • “date"date_to": "2023-05-09"

  • “exact"exact_match": false

  • “feature"feature_type": ["feature-type-url-1", "feature-type-url-2", ...]

  • “observed"observed_property": ["observed-property-url-1", ...]

  • “region"region": ["region-url-1", "region-url-2", ...]

  • “site"site_id": ["site-id-url-1", "site-id-url-2", ...]

  • “spatial"spatial": { }

Compared with the EcoPlots API search query, the only added field in the request body is related to the "query" parameter. This parameter provides users with the flexibility to choose between a full-text search or tokenised word search for a given species name across all the records stored in the database. For example, when the "exact_match" is set to true and the given speciesname is Allocasuarina torulosa. The API will be returning only the documents containing exact species name while setting it to false will result in documents that has either Allocasuarina or torulosa or full Allocasuarina torulosa.

...