ChecklistBankDataset icon

ChecklistBankDataset

ChecklistBank dataset viewer

Actions14

  • Dataset Search Actions
  • Decision Actions
  • Estimate Actions
  • Metadata Actions
  • Name Actions
  • Name Usage Actions
  • Name Usage Search Actions
  • Name Usage Suggest Actions
  • Reference Actions
  • Source Metadata Actions
  • Synonym Actions
  • Taxon Actions
  • Tree Actions
  • Vernacular Actions

Dataset Search → Get

AI-generated

Overview

The node "ChecklistBankDataset" provides access to the ChecklistBank API, specifically enabling users to search and retrieve datasets and related taxonomic information. The Dataset Search - Get operation allows querying datasets with various filters and sorting options.

This node is useful for workflows that require integration with biodiversity data, such as retrieving datasets about species, taxonomic classifications, or nomenclatural codes. For example, a researcher could use this node to find datasets containing bacterial taxonomy data filtered by license type and minimum dataset size.

Properties

Name Meaning
Query (q) The search query string used to find datasets.
Additional Fields A collection of optional filters and parameters to refine the dataset search:
- Has GBIF Key Boolean filter to include only datasets with a GBIF key present.
- License Filter datasets by license type. Options: CC0, CC BY, CC BY SA, CC BY NC, CC BY ND, CC BY NC SA, CC BY NC ND, Unspecified, Other.
- Minimum Size Numeric filter to include datasets with at least this many records.
- Nomenclatural Code Filter by nomenclatural code. Options: Bacterial, Botanical, Cultivars, Phytosociological, Virus, Zoological.
- Origin Filter by dataset origin. Options: External, Managed, Released.
- Type Filter by dataset type. Options: Nomenclatural, Taxonomic, Phylogenetic, Article, Legal, Thematic, Other.
- Sort By Sets the sort order of results. Options: Alias, Created Date, Creator, Key, Imported Date, Modified Date, Title, Relevance, Size.
- Reverse Boolean to reverse the sort order.
- Offset Numeric offset for paging through results.
- Limit Maximum number of results to return (minimum 1).

Output

The node outputs an array of JSON objects representing datasets matching the search criteria. Each object corresponds to a dataset record returned by the ChecklistBank API. The exact structure depends on the API response but typically includes dataset metadata such as keys, titles, licenses, sizes, and other descriptive fields.

No binary data output is produced by this operation.

Dependencies

  • Requires internet access to call the ChecklistBank public API at https://api.checklistbank.org/dataset.
  • No explicit API key or authentication is required based on the provided code.
  • Uses HTTP GET requests with query parameters to fetch data.
  • The node relies on n8n's built-in HTTP request helper for making API calls.

Troubleshooting

  • Empty Results: If no datasets are returned, verify the search query and filters. Some combinations may yield no matches.
  • Invalid Parameter Values: Using unsupported values for filters like license or nomenclatural code may cause errors or empty responses.
  • API Connectivity Issues: Network problems or API downtime will result in request failures. Check internet connectivity and API status.
  • Paging Parameters: Ensure limit and offset are set correctly to paginate through large result sets.
  • Unexpected Response Format: Changes in the external API might affect output structure; monitor for breaking changes.

Links and References

This summary focuses exclusively on the Dataset Search - Get operation of the ChecklistBankDataset node as requested.

Discussion