Welcome to TERN Knowledge Base

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

This section is aimed towards more technical users.

EcoPlots API supports 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.

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:

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:

{
   "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:

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:

{
   "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:

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:

{
   "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"
}
  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.