Dataqueries are different to Queries - they allow a deeper inquiry of species.
The Dataqueries endpoints are an integral part of EcoPlots API V5, specifically designed to retrieve data from EcoPlots based on specified species. These endpoints, namely /species/count, /species/observations, and /species/observed_property/list, are intended to facilitate efficient querying of relevant data. In this manual, we will comprehensively cover all the essential variables that must be supplied as URL parameters and/or request body for each endpoint, providing users with a clear understanding of what to anticipate from the API.
...
All three of the endpoints use the “speciesname” parameter in URL to take species name. Multiple species name (full or part of species name/taxonomy) can be passed at once using multiple occurrences of “speciesname” in URL parameter. eg. https:/{ecoplots-api-url}/api/v1.0/species/count?speciesname=Allocasuarina torulosa&speciesname=Eucalyptus
...
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.
...
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/TERNSupTDSAG/pages/23930471182676621402/NEW_EcoPlots+API+search+queries#Parameter-(observable-property)
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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] ]
]
}
}
} |
Endpoints
Endpoint | Description | URI Example | Example Response Body | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Method: POST Get the list all the unique species name or complete its taxanomy and count of it’s documents in the database by applying any combination following filters:
|
|
| ||||||||||||||||||||
| Method: POST Get the list all the unique observed property/parameter and its count by applying any combination following filters:
|
|
| ||||||||||||||||||||
| Method: POST Get the list all the observations made from the specified list of species by applying the following filters:
|
|
|