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

Biological Association → Get

AI-generated

Overview

This node integrates with the TaxonWorks API, a web-based workbench for taxonomists and biodiversity scientists. Specifically, the "Biological Association" resource with the "Get" operation allows users to retrieve biological association records from a specified TaxonWorks server.

Typical use cases include:

  • Fetching relationships between biological entities (e.g., species interactions or associations).
  • Querying biological association data filtered by various identifiers or types.
  • Integrating taxonomic or biodiversity data workflows where biological associations are relevant.

For example, a researcher might use this node to get all biological associations involving a particular subject or object identified by global IDs, or filter associations by relationship type.

Properties

Name Meaning
Server The URL of the TaxonWorks server to query (e.g., https://sfg.taxonworks.org).
Additional Fields Optional filters and pagination parameters to refine the query:
- Any Global ID Filter by any global identifier related to the association.
- Biological Association Object Type Filter by the type of the biological association's object.
- Biological Association Subject Type Filter by the type of the biological association's subject.
- Biological Relationship ID Filter by a specific biological relationship identifier.
- Object Global ID Filter by the global ID of the object in the association.
- Subject Global ID Filter by the global ID of the subject in the association.
- Page Pagination page number (for paged results).
- Per Number of items per page (page size).

Output

The node outputs an array of JSON objects representing the biological associations retrieved from the TaxonWorks API. Each object corresponds to a biological association record with fields as defined by the TaxonWorks API response.

No binary data output is produced by this node.

Dependencies

  • Requires access to a running TaxonWorks server with API enabled.
  • Requires credentials providing an API token for user authentication and a project token for project context.
  • The node uses HTTP GET requests to the TaxonWorks REST API endpoints.
  • The user must configure credentials containing valid API tokens for authentication.

Troubleshooting

  • Common issues:

    • Incorrect or unreachable server URL will cause connection errors.
    • Missing or invalid API tokens will result in authentication failures.
    • Improperly formatted additional fields may lead to unexpected API errors or empty results.
    • Pagination parameters (page and per) set incorrectly may cause no data or partial data retrieval.

  • Error messages:

    • HTTP 401 Unauthorized: Check that API tokens are correctly configured and valid.
    • HTTP 404 Not Found: Verify the server URL and resource endpoint correctness.
    • HTTP 400 Bad Request: Review the additional fields for invalid or unsupported parameters.
    • Network errors: Ensure network connectivity to the TaxonWorks server.

Links and References

Discussion