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

Notes → Get

AI-generated

Overview

This node integrates with the TaxonWorks web-based workbench, specifically to retrieve "Notes" data from a TaxonWorks server. It performs a "Get" operation on notes, allowing users to query notes by various criteria such as note ID, associated object IDs and types, text content, and pagination parameters.

Typical use cases include:

  • Fetching specific notes by their unique ID.
  • Searching for notes linked to particular objects (e.g., taxonomic names, specimens) by their IDs or types.
  • Searching notes containing specific text strings.
  • Retrieving paginated lists of notes for analysis or reporting.

For example, a biodiversity scientist might use this node to extract all notes related to certain taxon names or observations for further processing in an n8n workflow.

Properties

Name Meaning
Server The URL of the TaxonWorks server to connect to (e.g., https://sfg.taxonworks.org).
Additional Fields A collection of optional filters and parameters:
- ID Specific Note ID to retrieve.
- Note Object IDs Comma-separated list of IDs for objects associated with the notes (e.g., 1,2,3).
- Note Object Types One or more object types to filter notes by their associated object type. Options include:
Asserted Distribution, Attribution, Biological Association, Biological Relationship, Character State, Citation, Collecting Event, Collection Object Observation, Collection Object, Collection Profile, Common Name, Descriptor, Documentation, Document, Gene Attribute, Georeference, Image, Label, Loan Item, Loan, Observation Matrix Column Item, Observation Matrix Column, Observation Matrix, Observation Matrix Row Item, Observation Matrix Row, Observation, Organization, OTU, Person, Repository, Sequence, Sequence Relationship, Serial, SLED Image, Source, Sqed Depiction, Taxon Determination, Taxon Name Classification, Taxon Name, Taxon Name Relationship, Type Material, User.
- Object Global ID Identifier string for the note's source object.
- Text Text string to search for within the notes' content.
- Page Pagination page number (default 0).
- Per Number of results per page (default 0).

Output

The node outputs a JSON array containing the retrieved notes matching the query parameters. Each element in the array represents a note object as returned by the TaxonWorks API, including all available fields for that note.

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 REST API.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API tokens will cause authentication failures.
    • Invalid server URL or network issues may prevent connection.
    • Providing invalid filter values (e.g., malformed IDs or unsupported object types) may result in empty responses or errors.
    • Pagination parameters (page and per) set incorrectly may lead to unexpected result sets.

  • Error Messages:

    • HTTP 401 Unauthorized: Check that API tokens are correctly configured and valid.
    • HTTP 404 Not Found: Verify the server URL and resource path.
    • HTTP 400 Bad Request: Review the filter parameters for correctness and supported values.

  • Resolution Tips:

    • Ensure the TaxonWorks server URL is reachable and correct.
    • Confirm API tokens have sufficient permissions.
    • Validate input parameters against the allowed options.
    • Use small pagination sizes initially to test queries.

Links and References

Discussion