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 Relationships → Get

AI-generated

Overview

This node integrates with the TaxonWorks API, a web-based workbench for taxonomists and biodiversity scientists. Specifically, the "Taxon Name Relationships" resource with the "Get" operation allows users to retrieve taxonomic relationship data between taxon names from a TaxonWorks server.

Typical use cases include:

  • Fetching relationships such as synonyms, homonyms, or other nomenclatural links between taxon names.
  • Filtering taxon name relationships by various criteria like object or subject taxon IDs, classification sets, or specific relationship types.
  • Integrating taxonomic relationship data into workflows for biodiversity data analysis, curation, or reporting.

For example, a user might query all taxon name relationships of type "ICZN Synonym Of" for a set of taxon names to understand synonymy in a taxonomic group.

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 query:
- Object Taxon Name IDs Comma-separated list of taxon name IDs acting as the "object" in the relationship (e.g., 1,2,3).
- Subject Taxon Name IDs Comma-separated list of taxon name IDs acting as the "subject" in the relationship (e.g., 1,2,3).
- Taxon Name IDs Comma-separated list of taxon name IDs involved in the relationships (e.g., 1,2,3).
- Taxon Name Classification Set Multi-select options to filter by classification sets: "Exceptions", "Invalidating", "Validating".
- Taxon Name Relationship Type Multi-select options to filter by specific taxon name relationship types, including many detailed ICZN, ICN, ICNP, and ICVCN nomenclatural relationship categories (e.g., "ICZN Synonym Of", "ICN Junior Homonym Of").
- Page Number indicating the page of results to fetch (for pagination).
- Per Number indicating how many results per page to fetch (for pagination).

Output

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

Each item in the output JSON array corresponds to a taxon name relationship record, containing fields as defined by the TaxonWorks API for taxon name relationships. This typically includes identifiers, relationship types, linked taxon names, and metadata about the relationship.

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.
    • An API key credential for project authentication.
  • The node makes HTTP GET requests to the TaxonWorks REST API endpoints.
  • The server URL must be provided as input.

Troubleshooting

  • Authentication errors: Ensure that valid API tokens are provided via credentials and that the tokens have sufficient permissions on the TaxonWorks server.
  • Connection issues: Verify the server URL is correct and accessible from the n8n environment.
  • Empty results: Check that the filter parameters (IDs, classification sets, relationship types) match existing data on the server.
  • Pagination: If expecting many results, use the "Page" and "Per" properties to paginate through data.
  • Invalid parameter formats: Comma-separated ID lists must be properly formatted without spaces.
  • API changes: If the TaxonWorks API changes, the node may require updates to remain compatible.

Links and References

Discussion