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

Identifier → 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 about various taxonomic resources from a specified TaxonWorks server. The "Identifier" resource with the "Get" operation fetches identifier records based on multiple optional filtering criteria.

Typical use cases include:

  • Retrieving identifiers associated with taxonomic objects or namespaces.
  • Filtering identifiers by object IDs, types, namespaces, or pagination parameters.
  • Integrating taxonomic identifier data into workflows for further analysis or reporting.

For example, a user might query all identifiers linked to certain taxonomic objects or within a specific namespace to enrich their dataset or validate taxonomic information.

Properties

Name Meaning
Server The URL of the TaxonWorks server to connect to (e.g., https://sfg.taxonworks.org).
Additional Fields Optional filters to refine the query:
- Identifier Filter by the identifier string.
- Identifier Object IDs Comma-separated list of object IDs to filter identifiers related to these objects.
- Identifier Object Types Comma-separated list of object types to filter identifiers by type.
- Namespace ID Filter identifiers by namespace ID.
- Namespace Name Filter identifiers by namespace name.
- Namespace Short Name Filter identifiers by namespace short name.
- Object Global ID Filter identifiers by the global ID of the associated object.
- Type Filter by the type of identifier.
- Page Pagination page number (0-based).
- Per Number of results per page.

Output

The node outputs an array of JSON objects representing the retrieved identifiers from the TaxonWorks API. Each object corresponds to an identifier record with fields as returned by the API, including details such as identifier string, associated object IDs and types, namespace information, and other metadata.

No binary data output is produced 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 uses these tokens to authenticate requests to the TaxonWorks API.
  • The server URL must be correctly set in the "Server" property.

Troubleshooting

  • Authentication errors: Ensure that valid API tokens are provided via credentials and that the tokens have sufficient permissions.
  • Connection issues: Verify the server URL is reachable and correct, including protocol (http/https).
  • Invalid filter parameters: Check that comma-separated lists are properly formatted without extra spaces or invalid characters.
  • Pagination: If no results appear, verify the page and per values; setting them too high or low may result in empty responses.
  • API changes: If the TaxonWorks API changes, some filters or endpoints might become deprecated; check the API documentation for updates.

Links and References

Discussion