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

Asserted Distribution → Get

AI-generated

Overview

This node integrates with a TaxonWorks server, a web-based workbench for taxonomists and biodiversity scientists. Specifically, the "Asserted Distribution" resource with the "Get" operation allows users to retrieve asserted distribution data from the TaxonWorks API. This is useful for querying geographic distribution information related to taxa or operational taxonomic units (OTUs).

Typical use cases include:

  • Fetching geographic distribution records for specific OTUs.
  • Filtering distributions by geographic area or recent updates.
  • Paginating through large sets of asserted distribution data.

For example, a researcher could use this node to get all asserted distributions for a list of OTU IDs within a particular geographic area, helping in biodiversity studies or taxonomic revisions.

Properties

Name Meaning
Server The URL of the TaxonWorks server to connect to (e.g., https://sfg.taxonworks.org).
Additional Fields Optional filters and parameters to refine the query:
- Geographic Area ID Filter results by a specific geographic area identifier.
- OTU IDs Comma-separated list of OTU IDs to filter the asserted distributions (e.g., 1,2,3).
- Recent Boolean flag to filter only recent asserted distributions (true or false).
- Page Number indicating which page of results to retrieve (for pagination).
- Per Number indicating how many results per page to return (for pagination).

Output

The node outputs a JSON array containing the asserted distribution data retrieved from the TaxonWorks API. Each item in the array corresponds to an asserted distribution record matching the query parameters.

The output structure directly reflects the JSON response from the TaxonWorks API endpoint /api/v1/asserted_distributions. It includes fields such as geographic area identifiers, OTU references, and metadata about the distribution assertions.

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 (referred generically as "an API key credential").
    • A project token credential for project-specific access.
  • The node makes HTTP GET requests to the TaxonWorks REST API endpoints.
  • The server URL must be correctly specified in the "Server" property.

Troubleshooting

  • Authentication errors: If the API key or project token is invalid or missing, the node will fail to authenticate. Ensure that valid credentials are provided.
  • Connection issues: Incorrect server URL or network problems can cause request failures. Verify the server address and network connectivity.
  • Invalid parameters: Providing malformed OTU IDs or geographic area IDs may result in empty responses or errors. Use correct formats (e.g., comma-separated lists without spaces).
  • Pagination: If too many results are returned, consider using the "Page" and "Per" properties to paginate through data.
  • API changes: Changes in the TaxonWorks API might affect compatibility; ensure the node version matches the API version.

Links and References

If you need details on other resources or operations, please provide their names.

Discussion