Request Body
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
.
All the fields in request body are similar to EcoPlots API search queries except for exact_match
field under the query
. The following are all the subfields under query
field in request body.
"dataset": ["dataset-url-1", "dataset-url-2", ...]
“date_from": "2020-01-01"
“date_to": "2023-05-09"
“exact_match": false
In comparison to 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.“feature_type": ["feature-type-url-1", "feature-type-url-2", ...]
“observed_property": ["observed-property-url-1", ...]
“region": ["region-url-1", "region-url-2", ...]
“site_id": ["site-id-url-1", "site-id-url-2", ...]
“spatial": { }
NOTE: Except for "exact_match"
field, everything else is similar to EcoPlots API Search Query. More details about it can be found here -> https://ternaus.atlassian.net/wiki/spaces/TDSAG/pages/2676621402/NEW_EcoPlots+API+search+queries#Parameter-(observable-property)
Below is an example of mock request body. Please note that for endpoints other than /species/observations
, "page_number"
and "page_size"
is NOT required.
{ "page_number": 1, "page_size": 25, "query": { "dataset": [ "http://linked.data.gov.au/dataset/ausplots", "http://linked.data.gov.au/dataset/corveg" ], "date_from": "2006-01-01", "date_to": "2021-07-30", "exact_match": true, "feature_type": [ "http://linked.data.gov.au/def/tern-cv/2cf3ed29-440e-4a50-9bbc-5aab30df9fcd" ], "observed_property": [ "http://linked.data.gov.au/def/tern-cv/83ac0278-51cd-4d1a-8e05-7c1fc68cf020" ], "region": [ "http://linked.data.gov.au/dataset/asgs2016/stateorterritory/6", "http://linked.data.gov.au/dataset/bioregion/CYP" ], "site_id": [ "http://linked.data.gov.au/dataset/ausplots/site-nsabbs0001" ], "spatial": { "type" : "Polygon", "coordinates" : [ [ [100.0, 0.0], [101.0, 0.0], [101.0, 1.0], [100.0, 1.0], [100.0, 0.0] ] ] } } }
Add Comment