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

Image → Get

AI-generated

Overview

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

Typical use cases include:

  • Fetching images related to specific taxa or collection objects.
  • Searching images by identifiers, keywords, or user-related metadata.
  • Retrieving images filtered by date ranges or depiction types.

For example, a researcher could use this node to get all images associated with certain taxonomic units (OTUs) or those created/updated by a particular user within a date range.

Properties

Name Meaning
Server The URL of the TaxonWorks server to query (e.g., https://sfg.taxonworks.org).
Additional Fields A collection of optional filters and parameters to refine the image search:
- ID Specific image ID to retrieve.
- Ancestor ID Target The object class of ancestor (e.g., OTU) to filter images by their ancestor.
- Biocuration Class IDs Comma-separated list of biocuration class IDs to filter images.
- Collection Object IDs Comma-separated list of collection object IDs to filter images.
- Depiction Filter by depiction type or description.
- Identifier Filter images by identifier string.
- Identifier Start Filter images where the identifier starts with this string.
- Identifier End Filter images where the identifier ends with this string.
- Identifier Exact Filter images matching the exact identifier.
- Image IDs Comma-separated list of image IDs to filter.
- Keyword IDs And Comma-separated keyword IDs; images must have all these keywords.
- Keyword IDs Or Comma-separated keyword IDs; images may have any of these keywords.
- OTU IDs Comma-separated list of OTU (Operational Taxonomic Unit) IDs to filter images.
- SLED Image IDs Comma-separated list of SLED image IDs to filter images.
- Taxon Name IDs Comma-separated list of taxon name IDs to filter images.
- User Date Start Start date to filter images by user creation or update date.
- User Date End End date to filter images by user creation or update date.
- User ID Filter images created or updated by a specific user ID.
- User Target Whether to filter by creation date or update date (Created or Updated). Default is Updated.
- Page Pagination page number for results.
- Per Number of results per page.

Output

The node outputs an array of JSON objects representing the images retrieved from the TaxonWorks server. Each object contains the image data as returned by the API, including metadata such as identifiers, associated taxa, depiction details, user information, and other relevant fields.

No binary data output is indicated in the code; the output is purely JSON-formatted data.

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 makes HTTP GET requests to the TaxonWorks REST API endpoints.
  • The server URL must be provided as an input property.

Troubleshooting

  • Authentication errors: Ensure that valid API tokens are provided via credentials. Invalid or expired tokens will cause request failures.
  • Incorrect server URL: Verify the Server property points to a reachable TaxonWorks instance.
  • Invalid filter parameters: Using unsupported or malformed filter values may result in empty responses or API errors.
  • Pagination issues: If many results are expected, use Page and Per properties to paginate through results.
  • Network issues: Check network connectivity and firewall settings if requests fail.

Common error messages would typically come from the TaxonWorks API and might include HTTP 401 Unauthorized (invalid token), 404 Not Found (incorrect endpoint or resource), or 400 Bad Request (invalid query parameters). Resolving these involves checking credentials, server URL, and input parameters.

Links and References

If you need further details about other resources or operations, feel free to ask!

Discussion