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

Content → Get

AI-generated

Overview

This node integrates with the TaxonWorks API, a web-based workbench for taxonomists and biodiversity scientists. Specifically, the "Content" resource with the "Get" operation allows users to retrieve content records from a TaxonWorks server based on various filtering criteria.

Typical use cases include:

  • Searching for specific content entries by ID or text.
  • Filtering contents by associated OTU (Operational Taxonomic Unit) IDs or topic IDs.
  • Retrieving content created or updated within certain user date ranges.
  • Including related citations or depictions in the results.

For example, a researcher might use this node to fetch all content entries related to certain taxa (via OTU IDs) that were updated recently, including their citations and images, to prepare a report or update a database.

Properties

Name Meaning
Server The URL of the TaxonWorks server to connect to (e.g., https://sfg.taxonworks.org).
ID Specific content record ID to retrieve.
Citations Whether to include citation metadata with the content (true/false).
Depictions Whether to include depiction metadata (images, etc.) with the content (true/false).
Exact Whether to perform an exact match search on the text (true/false).
OTU ID Comma-separated list of OTU IDs to filter contents by (e.g., "1,2,3").
Text Text string to search for within the content records.
Topic ID Comma-separated list of topic IDs to filter contents by (e.g., "1,2,3").
User Date Start Start datetime to filter contents by user creation or update date.
User Date End End datetime to filter contents by user creation or update date.
User Target Whether to filter by creation date or update date ("Created" or "Updated").
User ID User ID to filter contents created or updated by a specific user.
Page Pagination page number (0-based).
Per Number of items per page to return.

Output

The node outputs a JSON array containing the retrieved content records from the TaxonWorks API. Each item corresponds to a content entry matching the specified filters.

The structure of each content object depends on the TaxonWorks API response but generally includes fields such as content ID, text, associated OTUs, topics, citations, depictions, user metadata, and timestamps.

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.
    • 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 set in the "Server" property.

Troubleshooting

  • Authentication errors: Ensure that valid API tokens are provided via credentials. Invalid or expired tokens will cause authorization failures.
  • Connection issues: Verify the server URL is reachable and correct. Network issues or incorrect URLs will cause request failures.
  • Invalid parameters: Passing malformed or unsupported filter values may result in empty responses or API errors. Double-check parameter formats, especially comma-separated lists.
  • Pagination: If many results are expected, use the "Page" and "Per" properties to paginate through results.
  • Empty results: Confirm that the filter criteria actually match existing content in the TaxonWorks project.

Links and References

Discussion