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

Citation → Get

AI-generated

Overview

This node integrates with the TaxonWorks API, a web-based workbench for taxonomists and biodiversity scientists. Specifically, the "Citation" resource with the "Get" operation allows users to retrieve citation data from a TaxonWorks server. This is useful for workflows that require accessing bibliographic references linked to taxonomic or biodiversity data.

Typical use cases include:

  • Fetching citations related to specific taxonomic objects or projects.
  • Filtering citations by attributes such as ID, source, or whether they are original.
  • Integrating citation metadata into larger biodiversity data pipelines or reports.

Example: Retrieve all citations associated with a particular taxon name or collection object to enrich dataset metadata or generate reference lists.

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 citation query:
- ID Specific citation ID to fetch.
- Citation Object ID ID of the object the citation is linked to.
- Citation Object Type Type of the object linked to the citation. Options: Asserted Distribution, Biological Association, Collection Object, Common Name, Image, OTU, Taxon Name, Taxon Name Classification, Taxon Name Relationship, Type Material.
- Original Filter by originality status of the citation. Options: Both, True, False.
- Source ID Filter citations by source ID.
- Page Pagination page number.
- Per Number of results per page.

Output

The node outputs an array of JSON objects representing the retrieved citations. Each object contains citation details as returned by the TaxonWorks API, including metadata fields relevant to the citation and its linked objects.

No binary data output is produced by this node.

Dependencies

  • Requires access to a running TaxonWorks server with API enabled.
  • Requires credentials providing user API token and project API token for authentication.
  • The node uses HTTP GET requests to the TaxonWorks REST API endpoints.
  • The user must configure appropriate credentials in n8n to authenticate API calls.

Troubleshooting

  • Authentication errors: Ensure that valid API tokens are provided via credentials; invalid or expired tokens will cause request failures.
  • Connection issues: Verify the server URL is correct and accessible from the n8n environment.
  • Invalid filter parameters: Using unsupported or incorrectly formatted additional fields may result in empty responses or errors.
  • Pagination: If many results are expected, use Page and Per properties to paginate through results properly.
  • API changes: Changes in the TaxonWorks API could affect compatibility; verify API version and endpoint availability.

Links and References

Discussion