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

AI-generated

Overview

This node integrates with the TaxonWorks platform, a web-based workbench for taxonomists and biodiversity scientists. Specifically, the "Taxon Names" resource with the "Get" operation allows users to retrieve detailed taxonomic name data from a TaxonWorks server.

Typical use cases include:

  • Fetching taxon names by scientific name or author.
  • Filtering taxon names based on nomenclature codes (e.g., ICZN, ICN).
  • Retrieving taxon names with specific classification types or relationships.
  • Querying taxon names within certain date ranges or validity statuses.

For example, a researcher could use this node to get all valid species-level taxon names authored by a particular scientist or to fetch taxon names that are hybrids or protonyms.

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 to refine the search:
- Author Filter taxon names by author name (string).
- Authors Filter by presence of authors: Both, With, Without.
- Citations Include citation metadata (boolean).
- Date Range Filter by date range with subfields:
  - Date Target Which date to target: Both, Created, Updated.
  - Date Start Start date/time for filtering.
  - Date End End date/time for filtering.
- Descendants Filter by descendants: N/A, Ancestors, Descendants.
- Exact Exact match flag (boolean).
- Etymology Filter by etymology presence: Both, With, Without.
- Leaves Filter by leaves presence: Both, With, Without.
- Nomenclature Code Filter by one or more nomenclature codes: Any Code, ICZN (Animals), ICN (Plants), ICNP (Bacteria), ICVCN (Viruses).
- Nomenclature Group Filter by nomenclatural rank group: Any Rank, Higher, Family, Genus, Species.
- OTUs Filter by presence of OTUs: Both, With, Without.
- Page Pagination page number (number).
- Per Number of results per page (number).
- Scientific Name Filter by scientific name (string).
- Taxon Name ID Comma-separated list of Taxon Name IDs (string).
- Taxon Name Relationship Type Filter by one or more taxon name relationship types (multiOptions). These include various ICZN, ICN, ICNP, and ICVCN relationship categories such as synonyms, homonyms, conserved names, misapplications, etc.
- Taxon Name Classification Type Filter by one or more taxon name classification types (multiOptions). Includes availability, validity, fossil status, Latinized gender/part of speech, and other taxonomic classifications.
- Taxon Name Type Filter by type of taxon name: Any, Combination, Hybrid, Protonym.
- Type Metadata Filter by presence of type metadata: Both, With, Without.
- Validity Filter by validity status: Both, Only Valid, Only Invalid.
- Year Filter by year (number).

Output

The node outputs an array of JSON objects representing the taxon names retrieved from the TaxonWorks API according to the specified filters. Each object contains detailed taxonomic information as provided by the API, including fields like scientific name, author, citations, nomenclature details, classification types, relationships, and metadata.

No binary data output is produced by this node.

Dependencies

  • Requires access to a running TaxonWorks server.
  • 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.

Troubleshooting

  • Invalid Credentials: If authentication tokens are incorrect or expired, the API will reject requests. Ensure valid API keys are configured.
  • Server Unreachable: If the specified server URL is incorrect or down, requests will fail. Verify the server address and network connectivity.
  • Incorrect Parameter Values: Using invalid filter values (e.g., wrong nomenclature codes or malformed IDs) may result in empty responses or errors. Double-check input parameters.
  • Pagination Issues: If many results exist, ensure page and per parameters are set appropriately to retrieve desired data chunks.
  • API Rate Limits: Excessive requests might be throttled by the server; consider adding delays or reducing request frequency.

Links and References

Discussion