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

Data Attribute → Get

AI-generated

Overview

This node integrates with the TaxonWorks API, a web-based workbench for taxonomists and biodiversity scientists. It allows users to retrieve data attributes from a specified TaxonWorks server instance. The "Get" operation for the "Data Attribute" resource fetches paginated lists of data attributes, which are metadata elements describing biological or taxonomic data.

Typical use cases include:

  • Retrieving data attribute definitions or metadata for further processing or analysis.
  • Integrating TaxonWorks data attributes into automated workflows for taxonomy or biodiversity research.
  • Synchronizing or exporting data attribute information from TaxonWorks to other systems.

Example: A researcher wants to list all data attributes available in their TaxonWorks project to understand what metadata fields are defined for specimens or observations.

Properties

Name Meaning
Server The URL of the TaxonWorks server to connect to (e.g., http://localhost:3000 or a remote URL).
Additional Fields Optional parameters to control pagination:
- Page: The page number to retrieve (default 0).
- Per: Number of items per page (default 0).

Output

The node outputs a JSON array containing the retrieved data attributes from the TaxonWorks API. Each item in the array represents a data attribute object as returned by the API, typically including fields such as ID, name, type, and other metadata describing the attribute.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to a TaxonWorks server.
  • Requires two credentials configured in n8n:
    • An API key credential for user authentication.
    • An API key credential for project authentication.
  • The node uses these tokens to authenticate API requests.
  • The server URL must be accessible from the n8n environment.

Troubleshooting

  • Authentication errors: Ensure that valid API tokens are provided via credentials and that they have sufficient permissions on the TaxonWorks server.
  • Connection issues: Verify the server URL is correct and reachable from the n8n instance.
  • Pagination parameters: If no results are returned, check if the page and per parameters are set correctly; defaults may return empty sets.
  • API changes: If the TaxonWorks API changes, the node might fail; verify compatibility with the current API version.
  • Empty response: Could indicate no data attributes exist or filters/pagination exclude all results.

Links and References

Discussion