Versions Compared

Old Version 1

changes.mady.by.user Leah Gustafson (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Leah Gustafson (Unlicensed)

Saved on

Key

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

EcoPlots API supports endpoints support the discovery and download of survey-based ecological data. For this purpose, a series of endpoints are available to allow users to download subsets of data, organised in the following key concepts.

Table of Contents
minLevel1
maxLevel7

Data endpoints

Datasources

All information in EcoPlots belongs to one of multiple datasources. To retrieve more details about the available datasources in EcoPlots, you should use the /datasources endpoint.

Request example:

Code Block
curl -X POST "https://ecoplots-test.tern.org.au/api/v1.0/datasources?dformat=ndjson" -H "accept: */*" -H "Authorization: apikey-v1 aAbBcC...xXyYzZ" -H "Content-Type: application/json" -d "{\"query\":{}}"

Response example:

Code Block
{
   "dataset":"TERN Surveillance Monitoring",
   "datasetId":"http://linked.data.gov.au/dataset/ausplots",
   "description":"<p> AusPlots is a collection of ecological data and samples gathered from a network of plots and transects across Australia by the TERN Ecosystem Surveillance team, using standardised methodologies. </p> <p>The AusPlots collection provides the ecological infrastructure to: </p> <ul><li>quantify the richness and cover of plant species (including weeds); </li><li>quantify the diversity and abundance of soil biodiversity; </li><li>assess the state, spatial heterogeneity and structural complexity of vegetation, including life-stage; </li><li>record vegetation and soil parameters that assist with the validation of remotely sensed ecological products;</li><li>analyse vegetation structure and change based on a series of photo reference images; </li><li>better estimate soil carbon and nutrient stocks; </li><li>conduct taxonomic validation studies based on collected plant voucher specimens; </li><li>conduct DNA barcoding and population genetic profiling based on collected tissue samples. </li></ul> <p> Overall this information will progress understanding of ecosystem processes, structure and function, and more generally progress understanding of the response to disturbance and longer-term environmental change of rangeland ecosystems, which underpins sustainable management practice.</p>.",
   "abstract":"N/A",
   "version":"2023-04-19",
   "created":null,
   "creator":"TERN Surveillance Monitoring ",
   "creatorId":"https://w3id.org/tern/resources/6be8678c-f354-47da-9667-46daf2a23ac7",
   "publisher":"Terrestrial Ecosystem Research Network (TERN)",
   "publisherId":"https://w3id.org/tern/resources/a083902d-d821-41be-b663-1d7cb33eea66",
   "spatial_extent_min_longitude":113.25800323486328,
   "spatial_extent_min_latitude":-42.09260177612305,
   "spatial_extent_max_longitude":152.89999389648438,
   "spatial_extent_max_latitude":-10.70300006866455
}
...
{ ... }

Datasets

Information in EcoPlots may belong to a smaller datasets, part off the main datasource (also called project). To retrieve more details about the available datasets in EcoPlots, you can use the /datasets endpoint.

Request example:

Code Block
curl -X POST "https://ecoplots-test.tern.org.au/api/v1.0/datasets?dformat=ndjson" -H "accept: */*" -H "Authorization: apikey-v1 aAbBcC...xXyYzZ" -H "Content-Type: application/json" -d "{\"query\":{}}"

Response example:

Code Block
{
   "project":"Biomass",
   "projectId":"http://linked.data.gov.au/dataset/tern-ecosystem-processes/dataset-biomass",
   "dataset":"TERN Ecosystem Processes",
   "datasetId":"http://linked.data.gov.au/dataset/tern-ecosystem-processes",
   "description":"The TERN Ecosystem Processes above-ground woody biomass Database contains diameter, height and above-ground woody biomass data collected across 15 TERN operated sites spanning 11 vegetation types such as: Mallee woodlands, Eucalypt forests and Rainforests. This database provides above-ground woody biomass values across multiple spatial scales: plant communities, plant individuals and individual stems.",
   "abstract":null,
   "version":null,
   "created":null,
   "creator":"TERN Ecosystem Processes",
   "creatorId":"https://w3id.org/tern/resources/8f2acf9f-3cf2-48c7-b911-ed1b1113932e",
   "publisher":"Terrestrial Ecosystem Research Network (TERN)",
   "publisherId":"https://w3id.org/tern/resources/a083902d-d821-41be-b663-1d7cb33eea66",
   "spatial_extent_min_longitude":116.93900299072266,
   "spatial_extent_min_latitude":-43.09550094604492,
   "spatial_extent_max_longitude":153.08799743652344,
   "spatial_extent_max_latitude":-13.178999900817871
}
...
{ ... }

Sites and SiteVisits

EcoPlots primarily contains on data collected in survey plots across Australia, hence other core information you can access is Plot/Site and SiteVisit. [Read more about Sites]

/sites and /sitevisits endpoints serve all the ecological sites (and their visits) information, including basic description of the site, latitude and longitude coordinates, establishment dates, visit dates and other useful details.

As any other endpoint from the Data category, a search query should be used in order to narrow the results. For example, a user may be only interested in sites that belong to a specific dataset, or sites within a specific geographic region across all datasets (see Search queries).

Sites

Request example:

Code Block
curl -X POST "https://ecoplots-test.tern.org.au/api/v1.0/sites?dformat=ndjson" -H "accept: */*" -H "Authorization: apikey-v1 your-api-key" -H "Content-Type: application/json" -d "{\"query\":{\"dataset\":[\"http://linked.data.gov.au/dataset/ausplots\"]}}"

Response example:

Code Block
{
   "dataset":"TERN Surveillance Monitoring",
   "datasetId":"http://linked.data.gov.au/dataset/ausplots",
   "siteName":"WAACOO0006",
   "siteId":"http://linked.data.gov.au/dataset/ausplots/site-waacoo0006",
   "siteType":"site",
   "siteTypeId":"http://linked.data.gov.au/def/tern-cv/5bf7ae21-a454-440b-bdd7-f2fe982d8de4",
   "dateCommissioned":"2013-08-20",
   "description":"Jilbadgi Nature Reserve, About 1.5km NE of Boodarding Rock, which is 37km SSE of Yellowdine. Salmon gum woodland immediately south of access track to Jilbadgi NR from Gt Eastern Hwy.",
   "dimension":"100.0x100.0",
   "latitude":"-31.596380",
   "longitude":"119.824100",
   "altitude":"N/A",
   "polygonWkt":"POLYGON((119.82412222 -31.59637778, 119.824125 -31.595475, 119.82517778 -31.595475, 119.82517778 -31.596375, 119.82412222 -31.59637778))",
   "pointWkt":"POINT(119.82412222 -31.59637778)",
   "pointPositionWithinPlot":"South West",
   "pointPositionWithinPlotId":"http://linked.data.gov.au/def/tern-cv/4dd22567-d692-44e7-b29d-b80eaff829dc"
}
{
   "dataset":"TERN Surveillance Monitoring",
   "datasetId":"http://linked.data.gov.au/dataset/ausplots",
   "siteName":"WAACOO0011",
   "siteId":"http://linked.data.gov.au/dataset/ausplots/site-waacoo0011",
   "siteType":"site",
   "siteTypeId":"http://linked.data.gov.au/def/tern-cv/5bf7ae21-a454-440b-bdd7-f2fe982d8de4",
   "dateCommissioned":"2013-10-04",
   "description":"Boorabbin National Park, About 6km south of Boorabbin on a large gypsum dune jutting into a lake chain.",
   "dimension":"100.0x100.0",
   "latitude":"-31.252840",
   "longitude":"120.341900",
   "altitude":"N/A",
   "polygonWkt":"POLYGON((120.34193861 -31.25283625, 120.34192222 -31.25188611, 120.34297222 -31.25188611, 120.34297222 -31.25278889, 120.34193861 -31.25283625))",
   "pointWkt":"POINT(120.34193861 -31.25283625)",
   "pointPositionWithinPlot":"South West",
   "pointPositionWithinPlotId":"http://linked.data.gov.au/def/tern-cv/4dd22567-d692-44e7-b29d-b80eaff829dc"
}
...
{
   "dataset":"TERN Surveillance Monitoring",
   "datasetId":"http://linked.data.gov.au/dataset/ausplots",
   "siteName":"WAACOO0007",
   "siteId":"http://linked.data.gov.au/dataset/ausplots/site-waacoo0007",
   "siteType":"site",
   "siteTypeId":"http://linked.data.gov.au/def/tern-cv/5bf7ae21-a454-440b-bdd7-f2fe982d8de4",
   "dateCommissioned":"2013-10-15",
   "description":"North part of Jilbadgi NR about 0.3 km west of Boodarding Rock.",
   "dimension":"100.0x100.0",
   "latitude":"-31.606720",
   "longitude":"119.807500",
   "altitude":"N/A",
   "polygonWkt":"POLYGON((119.80754722 -31.60672222, 119.80754722 -31.60582222, 119.8086 -31.60582222, 119.8086 -31.60672222, 119.80754722 -31.60672222))",
   "pointWkt":"POINT(119.80754722 -31.60672222)",
   "pointPositionWithinPlot":"South West",
   "pointPositionWithinPlotId":"http://linked.data.gov.au/def/tern-cv/4dd22567-d692-44e7-b29d-b80eaff829dc"
}
SiteVisits

Request example:

Code Block
curl -X POST "https://ecoplots-test.tern.org.au/api/v1.0/sitevisits?dformat=ndjson" -H "accept: */*" -H "Authorization: apikey-v1 your-api-key" -H "Content-Type: application/json" -d "{\"query\":{\"dataset\":[\"http://linked.data.gov.au/dataset/ausplots\"]}}"

Response example:

Code Block
{
   "dataset":"TERN Surveillance Monitoring",
   "datasetId":"http://linked.data.gov.au/dataset/ausplots",
   "siteName":"WAACOO0006",
   "siteId":"http://linked.data.gov.au/dataset/ausplots/site-waacoo0006",
   "siteVisitName":"20130723",
   "siteVisitId":"http://linked.data.gov.au/dataset/ausplots/sv-53438",
   "siteVisitStartDate":"2013-07-23T12:00:00Z",
   "siteVisitEndDate":"2013-07-24T09:24:00Z",
   "description":"Jilbadgi Nature Reserve, About 1.5km NE of Boodarding Rock, which is 37km SSE of Yellowdine. Salmon gum woodland immediately south of access track to Jilbadgi NR from Gt Eastern Hwy."
}
{
   "dataset":"TERN Surveillance Monitoring",
   "datasetId":"http://linked.data.gov.au/dataset/ausplots",
   "siteName":"WAACOO0011",
   "siteId":"http://linked.data.gov.au/dataset/ausplots/site-waacoo0011",
   "siteVisitName":"20131004",
   "siteVisitId":"http://linked.data.gov.au/dataset/ausplots/sv-53439",
   "siteVisitStartDate":"2013-10-04T16:01:00Z",
   "siteVisitEndDate":"2013-10-04T16:01:00Z",
   "description":"Boorabbin National Park, About 6km south of Boorabbin on a large gypsum dune jutting into a lake chain."
}
...
{
   "dataset":"TERN Surveillance Monitoring",
   "datasetId":"http://linked.data.gov.au/dataset/ausplots",
   "siteName":"WAACOO0007",
   "siteId":"http://linked.data.gov.au/dataset/ausplots/site-waacoo0007",
   "siteVisitName":"20130823",
   "siteVisitId":"http://linked.data.gov.au/dataset/ausplots/sv-53440",
   "siteVisitStartDate":"2013-08-23T10:40:00Z",
   "siteVisitEndDate":"2013-08-23T10:40:00Z",
   "description":"North part of Jilbadgi NR about 0.3 km west of Boodarding Rock."
}
Site or SiteVisit attributes

Site and SiteVisits can have additional attributes not defined in the Site and SiteVisits class as they may be dataset specific (i.e. the attribute is not shared/used across other datasets, so it is not explicitly defined in the ontology).

You can download all these attributes through the /sites/attributes and /sitevisits/attributes endpoints.

Request example:

Code Block
curl -X POST "https://ecoplots-test.tern.org.au/api/v1.0/sites/attributes?dformat=ndjson" -H "accept: */*" -H "Authorization: apikey-v1 your-api-key" -H "Content-Type: application/json" -d "{\"query\":{\"dataset\":[\"http://linked.data.gov.au/dataset/ausplots\"]}}"

Response example:

Code Block
{
   "attributeId":"http://linked.data.gov.au/dataset/ausplots/tern_site_location-attr-plot_length-59857",
   "siteName":"WAACOO0006",
   "siteId":"http://linked.data.gov.au/dataset/ausplots/site-waacoo0006",
   "attributeName":"plot length",
   "attributeConceptId":"http://linked.data.gov.au/def/tern-cv/9f8cc716-bc8c-40c4-be6b-6270813e94f3",
   "value":100.0,
   "valueId":"N/A",
   "valueUnit":"Metre",
   "valueUnitId":"http://qudt.org/vocab/unit/M"
}
{
   "attributeId":"http://linked.data.gov.au/dataset/ausplots/tern_site_location-attr-plot_shape-59857",
   "siteName":"WAACOO0006",
   "siteId":"http://linked.data.gov.au/dataset/ausplots/site-waacoo0006",
   "attributeName":"plot shape",
   "attributeConceptId":"http://linked.data.gov.au/def/tern-cv/8080742b-6855-4e27-812b-671d4dfe7e0f",
   "value":"square",
   "valueId":"http://linked.data.gov.au/def/tern-cv/b2e07a7f-942e-44d9-9fd6-f0cee7be103d",
   "valueUnit":"N/A",
   "valueUnitId":"N/A"
}
{
   "attributeId":"http://linked.data.gov.au/dataset/ausplots/tern_site_location-attr-plot_width-59857",
   "siteName":"WAACOO0006",
   "siteId":"http://linked.data.gov.au/dataset/ausplots/site-waacoo0006",
   "attributeName":"plot width",
   "attributeConceptId":"http://linked.data.gov.au/def/tern-cv/c230dd97-3af1-43cf-bd27-ffcf4979d3a1",
   "value":100.0,
   "valueId":"N/A",
   "valueUnit":"Metre",
   "valueUnitId":"http://qudt.org/vocab/unit/M"
}

Observations

All ecological measurements (plant height, animal count, soil pH, air temperature) in Ecoiplots are represented as observations. [Read more about Observations]

You can use this endpoint to extract observations based on several search criteria (see Search queries).

Request example:

Code Block
curl -X POST "https://ecoplots-test.tern.org.au/api/v1.0/observations?dformat=ndjson" -H "accept: */*" -H "Authorization: apikey-v1 your-api-key" -H "Content-Type: application/json" -d "{\"query\":{\"dataset\":[\"http://linked.data.gov.au/dataset/ausplots\"],\"site_id\":[\"http://linked.data.gov.au/dataset/ausplots/site-nsabbs0001\"],\"feature_type\":[\"http://linked.data.gov.au/def/tern-cv/b311c0d3-4a1a-4932-a39c-f5cdc1afa611\"],\"observed_property\":[\"http://linked.data.gov.au/def/tern-cv/56195246-ec5d-4050-a1c6-af786fbec715\"]}}"

Response example:

Code Block
{
  "dataset":"TERN Surveillance Monitoring",
  "datasetId":"http://linked.data.gov.au/dataset/ausplots",
  "featureId":"http://linked.data.gov.au/dataset/ausplots/site_visit_id-58580-plant_occurr_id-54882275",
  "featureType":"plant occurrence",
  "featureTypeId":"http://linked.data.gov.au/def/tern-cv/b311c0d3-4a1a-4932-a39c-f5cdc1afa611",
  "observationId":"http://linked.data.gov.au/dataset/ausplots/point_intercept-obs-species_name-54882275",
  "resultTime":"2018-05-11T00:00:00Z",
  "parameter":"scientific name",
  "parameterId":"http://linked.data.gov.au/def/tern-cv/56195246-ec5d-4050-a1c6-af786fbec715",
  "result":"Boraginaceae",
  "resultId":"N/A",
  "resultUnit":"N/A",
  "resultUnitId":"N/A",
  "method":"Vegetation vouchering - vascular plants",
  "methodId":"http://linked.data.gov.au/def/ausplots-cv/1d39b897-d6d3-40e9-8113-8ebeab2cd38e",
  "instrumentId":"N/A",
  "instrumentType":"N/A",
  "instrumentTypeId":"N/A",
  "siteName":"NSABBS0001",
  "siteId":"http://linked.data.gov.au/dataset/ausplots/site-nsabbs0001",
  "siteVisitName":"20180511",
  "siteVisitId":"http://linked.data.gov.au/dataset/ausplots/sv-58580",
  "transectName":"NSABBS0001-transect-E4-W4",
  "transectId":"http://linked.data.gov.au/dataset/ausplots/site-nsabbs0001-transect-e4-w4"
}
...
{
  "dataset":"TERN Surveillance Monitoring",
  "datasetId":"http://linked.data.gov.au/dataset/ausplots",
  "featureId":"http://linked.data.gov.au/dataset/ausplots/site_visit_id-58580-plant_occurr_id-54882275",
  "featureType":"plant occurrence",
  "featureTypeId":"http://linked.data.gov.au/def/tern-cv/b311c0d3-4a1a-4932-a39c-f5cdc1afa611",
  "observationId":"http://linked.data.gov.au/dataset/ausplots/point_intercept-obs-species_name-54882275",
  "resultTime":"2018-05-11T00:00:00Z",
  "parameter":"scientific name",
  "parameterId":"http://linked.data.gov.au/def/tern-cv/56195246-ec5d-4050-a1c6-af786fbec715",
  "result":"Boraginaceae",
  "resultId":"N/A",
  "resultUnit":"N/A",
  "resultUnitId":"N/A",
  "method":"Vegetation vouchering - vascular plants",
  "methodId":"http://linked.data.gov.au/def/ausplots-cv/1d39b897-d6d3-40e9-8113-8ebeab2cd38e",
  "instrumentId":"N/A",
  "instrumentType":"N/A",
  "instrumentTypeId":"N/A",
  "siteName":"NSABBS0001",
  "siteId":"http://linked.data.gov.au/dataset/ausplots/site-nsabbs0001",
  "siteVisitName":"20180511",
  "siteVisitId":"http://linked.data.gov.au/dataset/ausplots/sv-58580",
  "transectName":"NSABBS0001-transect-E4-W4",
  "transectId":"http://linked.data.gov.au/dataset/ausplots/site-nsabbs0001-transect-e4-w4"
}
Observation attributes

Observations can have additional attributes. E.g., an observation might have an attribute “angle count point name”, but not all sampling protocols record this attribute, so the property does not belong to the Observation itself and it is defined as an additional attribute.

You can download all these attributes through the /observations/attributes endpoint.

Request example:

Code Block
curl -X POST "http://localhost:5000/api/v1.0/observations/attributes?dformat=ndjson" -H "accept: */*" -H "Content-Type: application/json" -d "{\"page_number\":1,\"page_size\":10,\"query\":{\"dataset\":[\"http://linked.data.gov.au/dataset/ausplots\"],\"site_id\":[\"http://linked.data.gov.au/dataset/ausplots/site-nsabbs0001\"]}}"

Response example:

Code Block
{
   "attributeId":"http://linked.data.gov.au/dataset/ausplots/tern_basal_area-attr-point_id-475048",
   "observationId":"http://linked.data.gov.au/dataset/ausplots/tern_basal_area-obs-basal_area-475048",
   "attributeName":"angle count point name",
   "attributeConceptId":"http://linked.data.gov.au/def/tern-cv/46d2e568-72cd-4df3-b0ed-4ebdaf771e4c",
   "value":"NW",
   "valueId":"N/A",
   "valueUnit":"N/A",
   "valueUnitId":"N/A"
}
...
{
   "attributeId":"http://linked.data.gov.au/dataset/ausplots/tern_basal_area-attr-point_id-475069",
   "observationId":"http://linked.data.gov.au/dataset/ausplots/tern_basal_area-obs-basal_area-475069",
   "attributeName":"angle count point name",
   "attributeConceptId":"http://linked.data.gov.au/def/tern-cv/46d2e568-72cd-4df3-b0ed-4ebdaf771e4c",
   "value":"E",
   "valueId":"N/A",
   "valueUnit":"N/A",
   "valueUnitId":"N/A"
}

Feature of interest attributes

In the TERN Ontology, a Feature of Interest (FOI) is an ecological scale (e.g. plant individual, animal population, soil, climate). Observations are grouped by ecological scales (FOI) and the FOI type and feature id for each observation are returned with the observation. [Read more about Feature of Interest]

However, every instance of FOI may have additional attributes related exclusively to the instance. This information can be accessed via the /foi/attributes endpoint.

Request example:

Code Block
curl -X POST "https://ecoplots-test.tern.org.au/api/v1.0/foi/attributes?dformat=ndjson" -H "accept: */*" -H "Authorization: apikey-v1 your-api-key" -H "Content-Type: application/json" -d "{\"query\":{\"dataset\":[\"http://linked.data.gov.au/dataset/ausplots\"],\"site_id\":[\"http://linked.data.gov.au/dataset/ausplots/site-nsabbs0001\"]}}"

Response example:

Code Block
{
   "attributeId":"http://linked.data.gov.au/dataset/ausplots/soil_characterisation-attr-lower_depth-122923",
   "featureId":"http://linked.data.gov.au/dataset/ausplots/site_visit_id-58580-soil_char_id-122923",
   "attributeName":"soil depth max",
   "attributeConceptId":"http://linked.data.gov.au/def/tern-cv/263d7143-e88d-4105-83e7-00d75035a2b3",
   "value":0.1,
   "valueId":"N/A",
   "valueUnit":"Metre",
   "valueUnitId":"http://qudt.org/vocab/unit/M"
}
{
   "attributeId":"http://linked.data.gov.au/dataset/ausplots/soil_characterisation-attr-upper_depth-122923",
   "featureId":"http://linked.data.gov.au/dataset/ausplots/site_visit_id-58580-soil_char_id-122923",
   "attributeName":"soil depth min",
   "attributeConceptId":"http://linked.data.gov.au/def/tern-cv/376efe60-0550-42b4-b90b-110015806dc7",
   "value":0.0,
   "valueId":"N/A",
   "valueUnit":"Metre",
   "valueUnitId":"http://qudt.org/vocab/unit/M"
}
...
{
   "attributeId":"http://linked.data.gov.au/dataset/ausplots/soil_characterisation-attr-layer_barcode-122923",
   "featureId":"http://linked.data.gov.au/dataset/ausplots/site_visit_id-58580-soil_char_id-122923",
   "attributeName":"voucher barcode",
   "attributeConceptId":"http://linked.data.gov.au/def/tern-cv/6d351831-45da-403c-919b-1cee41950488",
   "value":"NST004264",
   "valueId":"N/A",
   "valueUnit":"N/A",
   "valueUnitId":"N/A"
}

Instrument attributes

When an instrument was used to measure the result of an observation, the type of instrument and the instrument instance id is returned along the observation data.

However, an instance of an Instrument may have additional attributes related exclusively to the instance. This information can be accessed via the /instruments/attributes endpoint.

Request example:

Code Block
curl -X POST "https://ecoplots-test.tern.org.au/api/v1.0/instruments/attributes?dformat=ndjson" -H "accept: */*" -H "Authorization: apikey-v1 your-api-key" -H "Content-Type: application/json" -d "{\"query\":{\"dataset\":[\"http://linked.data.gov.au/dataset/ausplots\"],\"site_id\":[\"http://linked.data.gov.au/dataset/ausplots/site-nsabbs0001\"]}}"

Response example:

Code Block
{
   "attributeId":"http://linked.data.gov.au/dataset/ausplots/tern_basal_area-attr-basal_area_factor-475048",
   "instrumentId":"http://linked.data.gov.au/dataset/ausplots/tern_basal_area-inst-basal_area-475048",
   "attributeName":"basal area factor",
   "attributeConceptId":"http://linked.data.gov.au/def/tern-cv/dd34fc05-012d-4092-9324-a4cbcf29bf0a",
   "value":0.1,
   "valueId":"N/A",
   "valueUnit":"Unitless",
   "valueUnitId":"http://qudt.org/vocab/unit/UNITLESS"
}
...
{
   "attributeId":"http://linked.data.gov.au/dataset/ausplots/tern_basal_area-attr-basal_area_factor-475069",
   "instrumentId":"http://linked.data.gov.au/dataset/ausplots/tern_basal_area-inst-basal_area-475069",
   "attributeName":"basal area factor",
   "attributeConceptId":"http://linked.data.gov.au/def/tern-cv/dd34fc05-012d-4092-9324-a4cbcf29bf0a",
   "value":1.0,
   "valueId":"N/A",
   "valueUnit":"Unitless",
   "valueUnitId":"http://qudt.org/vocab/unit/UNITLESS"
}

Taxon

EcoPlots stores Taxonomic information about all vegetative species collected in the various datasets. This information is sourced from Australian Plant Name Index, and it can be retrieved using the /taxon endpoint.

Request example:

Code Block
curl -X POST "http://localhost:5000/api/v1.0/taxon?dformat=ndjson" -H "accept: */*" -H "Content-Type: application/json" -d "{\"query\":{\"dataset\":[\"http://linked.data.gov.au/dataset/ausplots\"],\"site_id\":[\"http://linked.data.gov.au/dataset/ausplots/site-nsabbs0001\"]}}"

Response example:

Code Block
{
   "taxonID":"https://id.biodiversity.org.au/taxon/apni/51612493",
   "scientificNameID":"https://id.biodiversity.org.au/name/apni/54714",
   "scientificName":"Boraginaceae Juss.",
   "scientificNameAuthorship":"Juss.",
   "acceptedNameID":"https://id.biodiversity.org.au/taxon/apni/51612493",
   "acceptedName":"Boraginaceae Juss.",
   "nameAccordingToID":"https://id.biodiversity.org.au/reference/apni/46762",
   "nameAccordingTo":"CHAH (2008), Australian Plant Census",
   "namePublishedInID":"None",
   "namePublishedIn":"None",
   "namePublishedInYear":"None",
   "originalNameUsageID":"None",
   "originalNameUsage":"None",
   "parentNameUsageID":"None",
   "parentNameUsage":"None",
   "conceptID":"https://id.biodiversity.org.au/instance/apni/650956",
   "nomenclaturalStatus":"nom. cons.",
   "nomenclaturalCode":"ICN",
   "taxonomicStatus":"accepted",
   "higherClassification":"Plantae|Charophyta|Equisetopsida|Magnoliidae|Asteranae|Boraginaceae",
   "kingdom":"Plantae",
   "class":"Equisetopsida",
   "order":"None",
   "family":"Boraginaceae",
   "subfamily":"None",
   "genus":"None",
   "subgenus":"None",
   "phylum":"None",
   "specificEpithet":"None",
   "cultivarEpithet":"None",
   "genericName":"None",
   "infragenericEpithet":"None",
   "infraspecificEpithet":"None",
   "taxonRank":"None",
   "taxonRemarks":"None",
   "verbatimTaxonRank":"None",
   "vernacularName":"None"
}{
   "taxonID":"https://id.biodiversity.org.au/node/apni/2892197",
   "scientificNameID":"https://id.biodiversity.org.au/name/apni/114499",
   "scientificName":"Eucalyptus crebra F.Muell.",
   "scientificNameAuthorship":"F.Muell.",
   "acceptedNameID":"https://id.biodiversity.org.au/node/apni/2892197",
   "acceptedName":"Eucalyptus crebra F.Muell.",
   "nameAccordingToID":"https://id.biodiversity.org.au/reference/apni/42942",
   "nameAccordingTo":"CHAH (2006), Australian Plant Census",
   "namePublishedInID":"None",
   "namePublishedIn":"None",
   "namePublishedInYear":"None",
   "originalNameUsageID":"None",
   "originalNameUsage":"None",
   "parentNameUsageID":"None",
   "parentNameUsage":"None",
   "conceptID":"https://id.biodiversity.org.au/instance/apni/612750",
   "nomenclaturalStatus":"",
   "nomenclaturalCode":"ICN",
   "taxonomicStatus":"accepted",
   "higherClassification":"Plantae|Charophyta|Equisetopsida|Magnoliidae|Rosanae|Myrtales|Myrtaceae|Eucalyptus|crebra",
   "kingdom":"Plantae",
   "class":"Equisetopsida",
   "order":"None",
   "family":"Myrtaceae",
   "subfamily":"None",
   "genus":"None",
   "subgenus":"None",
   "phylum":"None",
   "specificEpithet":"None",
   "cultivarEpithet":"None",
   "genericName":"None",
   "infragenericEpithet":"None",
   "infraspecificEpithet":"None",
   "taxonRank":"None",
   "taxonRemarks":"None",
   "verbatimTaxonRank":"None",
   "vernacularName":"None"
}

Discovery endpoints

Discover endpoint helps to retrieve all the possible values of specific variables within EcoPlots. You can easily find the desired values to be used in your queries.

You can retrieve values from:

"region_type", "region", "dataset", "site_id", "site_visit_id", "feature_type", "observed_property"

Request example:

Code Block
curl -X GET "http://localhost:5000/api/v1.0/discover/feature_type" -H "accept: application/json"

Response example:

Code Block
[
  {
    "key": "soil-sample",
    "label": "soil sample",
    "uri": "http://linked.data.gov.au/def/tern-cv/06461021-a6c2-4175-9651-23653c2b9116"
  },
  {
    "key": "animal-occurrence",
    "label": "animal occurrence",
    "uri": "http://linked.data.gov.au/def/tern-cv/2361dea8-598c-4b6f-a641-2b98ff199e9e"
  },
  {
    "key": "landform",
    "label": "landform",
    "uri": "http://linked.data.gov.au/def/tern-cv/2cf3ed29-440e-4a50-9bbc-5aab30df9fcd"
  },
  {
    "key": "plant-specimen",
    "label": "plant specimen",
    "uri": "http://linked.data.gov.au/def/tern-cv/2e122e23-881c-43fa-a921-a8745f016ceb"
  },
  {
    "key": "vegetation-stratum",
    "label": "vegetation stratum",
    "uri": "http://linked.data.gov.au/def/tern-cv/32834f36-a478-45be-97f4-ff2ff51e9f5c"
  },
  {
    "key": "fungal-occurrence",
    "label": "fungal occurrence",
    "uri": "http://linked.data.gov.au/def/tern-cv/45a73139-f6bf-47b7-88d4-4b2865755545"
  },
  {
    "key": "plant-individual",
    "label": "plant individual",
    "uri": "http://linked.data.gov.au/def/tern-cv/60d7edf8-98c6-43e9-841c-e176c334d270"
  },
  {
    "key": "climate",
    "label": "climate",
    "uri": "http://linked.data.gov.au/def/tern-cv/6d40d71e-58cd-4f75-8304-40c01fe5f74c"
  },
  {
    "key": "land-surface-disturbance",
    "label": "land surface disturbance",
    "uri": "http://linked.data.gov.au/def/tern-cv/7e256d28-e686-4b6a-b64a-ac1b1a8f164d"
  },
  {
    "key": "soil-profile",
    "label": "soil profile",
    "uri": "http://linked.data.gov.au/def/tern-cv/80c39b95-0912-4267-bb66-2fa081683723"
  },
  {
    "key": "land-surface",
    "label": "land surface",
    "uri": "http://linked.data.gov.au/def/tern-cv/8282fb22-4135-415c-8ca2-317860d102fb"
  },
  {
    "key": "soil",
    "label": "soil",
    "uri": "http://linked.data.gov.au/def/tern-cv/98e8d72d-f361-41ed-af9d-6e7f90c1dfce"
  },
  {
    "key": "land-surface-substrate",
    "label": "land surface substrate",
    "uri": "http://linked.data.gov.au/def/tern-cv/aef12cd6-3826-4988-a54c-8578d3fb4c8d"
  },
  {
    "key": "geologic-substrate",
    "label": "geologic substrate",
    "uri": "http://linked.data.gov.au/def/tern-cv/afc81cca-9122-4e36-823d-31dd765e9257"
  },
  {
    "key": "plant-occurrence",
    "label": "plant occurrence",
    "uri": "http://linked.data.gov.au/def/tern-cv/b311c0d3-4a1a-4932-a39c-f5cdc1afa611"
  },
  {
    "key": "vegetation-disturbance",
    "label": "vegetation disturbance",
    "uri": "http://linked.data.gov.au/def/tern-cv/d4fc54b1-0ad3-4512-86b7-d42b121ece45"
  },
  {
    "key": "plant-community",
    "label": "plant community",
    "uri": "http://linked.data.gov.au/def/tern-cv/ea3a4c64-dac3-4660-809a-8ad5ced8997b"
  }
]

Following the use of this endpoint /discover/feature_type, we know that EcoPlots stores data about all items in the list of FOI returned. We can now use, for instance, the filter

Code Block
"feature_type": ["http://linked.data.gov.au/def/tern-cv/98e8d72d-f361-41ed-af9d-6e7f90c1dfce"]

to only retrieve soil informationthe data that is available.

Each endpoint has its own sub-section containing examples.

Child pages (Children Display)

...

The API endpoint use examples in this section use a cURL command-line request sent via HTTP. Request examples will contain "X-Api-Key: aAbBcC...xXyYzZ". Replace aAbBcC...xXyYzZ with your own API key that you have generated in your TERN account remembering to keep the final double quote (“).

In addition, if you have installed the jq command-line tool, you can pipe the output to format the response JSON string nicely (pretty print). The request response examples have been pretty print formatted to aid with readability.

Due to the size of the responses, the example responses are only excerpts of the data that is available when the command line request is run.