Taxon observations

Get all taxon observations

Retrieve a paginated collection of all taxon observations recorded in VegBank.

get/taxon-observations

Query parameters

detail'minimal' | 'full'

Level of detail for the response:

  • minimal: Returns basic fields only
  • full: Returns more fields
with_nestedboolean

Whether to include nested fields in the response

limitinteger

Maximum number of records to return

offsetinteger

Number of records to skip before starting to return records

create_parquetboolean

If true, return data payload in binary Parquet format

Response

Matching taxon observation(s), with fields based on parameters:

  • detail=minimal&with_nested=false: Basic fields only
  • detail=minimal&with_nested=true: Basic fields + nested array fields
  • detail=full&with_nested=false: Extended fields, no nested array fields
  • detail=full&with_nested=true: Extended fields + nested array fields
OR
OR
OR

Example response

{
  "count": 115000,
  "data": [
    {
      "to_code": "to.1",
      "ob_code": "ob.1",
      "int_curr_pc_code": "pc.1",
      "int_orig_pc_code": "pc.1",
      "taxon_inference_area": 405,
      "rf_code": "rf.1"
    }
  ]
}

Changes

Changed in 4 of the 50 revisions of this API.51613

  • c37c8d7a84c51126See the full diff
    • added to the response body oneOf list for the response status

      response-body-one-of-added

    • removed the optional property /////////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////////// from the response with the status

      response-optional-property-removed

    • added the new optional query request parameter detail

      new-optional-request-parameter

    • added the optional property /////////// to the response with the status

      response-optional-property-added

    • added the optional property /////////// to the response with the status

      response-optional-property-added

    • added to the ////// response property allOf list for the response status

      response-property-all-of-added

    • added to the ////// response property allOf list for the response status

      response-property-all-of-added

    • removed from the ////// response property allOf list for the response status

      response-property-all-of-removed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2e123831df6e346See the full diff
    • for the query request parameter limit, default value 1000 was added

      request-parameter-default-value-added

    • for the query request parameter offset, default value 0 was added

      request-parameter-default-value-added

    • added to the response body oneOf list for the response status

      response-body-one-of-added

    • for the query request parameter limit, the min was set to 0.00

      request-parameter-min-set

    • for the query request parameter offset, the min was set to 0.00

      request-parameter-min-set

    • deleted the query request parameter detail

      request-parameter-removed

    • deleted the query request parameter numTaxa

      request-parameter-removed

    • api operation id get-to was added

      api-operation-id-added

    • api tag Taxon observations added

      api-tag-added

    • added the new optional query request parameter create_parquet

      new-optional-request-parameter

    • added the new optional query request parameter with_nested

      new-optional-request-parameter

    • added the media type application/vnd.apache.parquet for the response with the status

      response-media-type-added

    • added the non-success response with the status

      response-non-success-status-added

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 83 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.