TaxonWorks icon

TaxonWorks

TaxonWorks is an integrated web-based workbench for taxonomists and biodiversity scientists

Actions20

  • Asserted Distribution Actions
  • Biological Association Actions
  • Citation Actions
  • Collecting Event Actions
  • Collection Object Actions
  • Content Actions
  • Data Attribute Actions
  • Download Actions
  • Identifier Actions
  • Image Actions
  • Notes Actions
  • Observation Matrices Actions
  • Observations Actions
  • OTUs Actions
  • People Actions
  • Projects Actions
  • Sources Actions
  • Taxon Name Classifications Actions
  • Taxon Name Relationships Actions
  • Taxon Names Actions

OTUs → Get

AI-generated

Overview

This node integrates with the TaxonWorks API, a web-based workbench for taxonomists and biodiversity scientists. Specifically, the "OTUs" resource with the "Get" operation allows users to retrieve Operational Taxonomic Units (OTUs) data from a specified TaxonWorks server.

Typical use cases include:

  • Fetching OTU records by various filters such as OTU IDs, names, or associated taxon names.
  • Retrieving OTUs linked to specific biological associations or classifications.
  • Paginating through large sets of OTU data for analysis or reporting.

For example, a researcher could use this node to query OTUs by their scientific name or by a list of OTU IDs to integrate taxonomy data into a workflow for biodiversity data processing.

Properties

Name Meaning
Server The URL of the TaxonWorks server to connect to (e.g., https://sfg.taxonworks.org).
Additional Fields A collection of optional filters and parameters to refine the OTU query:
- Biological Association IDs Comma-separated list of biological association IDs to filter OTUs.
- Data Attributes Filter OTUs by associated data attributes.
- Name Label or name of the OTU to search for.
- OTU ID Single OTU ID to fetch.
- OTU IDs Comma-separated list of OTU IDs (e.g., 1,2,3) to fetch multiple OTUs.
- Taxon Name Classification IDs Comma-separated list of taxon name classification IDs to filter OTUs.
- Taxon Name IDs Comma-separated list of taxon name IDs to filter OTUs.
- Taxon Name Relationship IDs Comma-separated list of taxon name relationship IDs to filter OTUs.
- Page Pagination page number (integer).
- Per Number of items per page (integer).

Output

The node outputs an array of JSON objects representing the OTUs retrieved from the TaxonWorks API according to the specified filters. Each object corresponds to an OTU record with its associated metadata as provided by the API.

No binary data output is produced by this node.

Dependencies

  • Requires valid credentials for accessing the TaxonWorks API, specifically an API token for user authentication and a project token.
  • The node expects the TaxonWorks server URL to be reachable and properly configured.
  • Network connectivity to the specified TaxonWorks server is necessary.

Troubleshooting

  • Authentication Errors: If the API tokens are invalid or missing, the node will fail to authenticate. Ensure that valid API credentials are configured in n8n.
  • Connection Issues: If the server URL is incorrect or unreachable, requests will fail. Verify the server address and network access.
  • Invalid Parameters: Providing malformed or unsupported filter values (e.g., improperly formatted comma-separated lists) may cause the API to reject the request. Double-check input formats.
  • Pagination Limits: Requesting pages beyond available data may return empty results; adjust page and per accordingly.
  • API Rate Limits: Excessive requests might be throttled by the TaxonWorks server; consider adding delays or reducing request frequency.

Links and References

Discussion