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

Taxon Name Classifications → Get

AI-generated

Overview

This node integrates with the TaxonWorks API, a web-based workbench for taxonomists and biodiversity scientists. Specifically, the "Taxon Name Classifications" resource with the "Get" operation allows users to retrieve taxon name classification data from a specified TaxonWorks server.

Typical use cases include:

  • Fetching classifications of taxon names based on various filters such as IDs, classification types, or classification sets.
  • Integrating taxonomic classification data into workflows for biodiversity data analysis, reporting, or further processing.
  • Querying specific taxon name classifications to validate or enrich taxonomic datasets.

For example, a user might want to get all taxon name classifications related to certain taxon name IDs or filter by classification types like "ICZN Valid" or "ICN Validly Published".

Properties

Name Meaning
Server The URL of the TaxonWorks server to query (e.g., https://sfg.taxonworks.org).
Additional Fields A collection of optional filters and parameters:
- Taxon Name IDs Comma-separated list of taxon name IDs to filter results (e.g., "1,2,3").
- Taxon Name Classification Type Multiple selectable classification types to filter by. These correspond to detailed taxonomic classification categories such as ICZN Available, ICZN Invalid, ICN Validly Published, ICNP Legitimate, Latinized Gender/Part of Speech, etc.
- Taxon Name Classification Set Multi-select options to filter by classification sets: "Exceptions", "Invalidating", "Validating".
Page Pagination page number (default 0).
Per Number of items per page (default 0, meaning default server behavior).

Output

The node outputs an array of JSON objects representing the taxon name classifications retrieved from the TaxonWorks API according to the specified filters.

Each item in the output corresponds to a taxon name classification record, including fields as provided by the TaxonWorks API. The exact structure depends on the API response but typically includes identifiers, classification types, associated taxon name IDs, and metadata.

No binary data is output by this node.

Dependencies

  • Requires access to a running TaxonWorks server with API enabled.
  • Requires two credentials configured in n8n:
    • An API key credential for user authentication (referred generically as "an API key credential").
    • An API key credential for project authentication (referred generically as "a required project API authentication token").
  • The node makes HTTP GET requests to the TaxonWorks REST API endpoints.
  • The user must provide the server URL and valid credentials.

Troubleshooting

  • Authentication errors: If the API keys are invalid or missing, the node will fail to authenticate. Ensure that both user and project API tokens are correctly configured.
  • Incorrect server URL: Providing an incorrect or unreachable server URL will cause request failures. Verify the server address and network connectivity.
  • Invalid filter values: Using unsupported or malformed filter values (e.g., invalid taxon name IDs or classification types) may result in empty responses or API errors.
  • Pagination issues: If large datasets are expected, ensure proper use of page and per parameters to paginate results effectively.
  • API rate limits or server errors: The TaxonWorks server may impose rate limits or experience downtime; handle such errors gracefully in your workflow.

Links and References

Discussion