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

Name Usage Suggest → Get

AI-generated

Overview

This node integrates with the ChecklistBank API to retrieve taxonomic and biodiversity data from various datasets. It supports multiple resources such as datasets, decisions, estimates, metadata, names, name usages, references, sources, synonyms, taxa, trees, and vernacular names. The "Get" operation fetches data based on user-specified parameters.

The Name Usage Suggest - Get operation specifically provides suggestions for scientific names based on a search query. This is useful in scenarios where users want to autocomplete or find possible scientific names matching partial input, optionally filtered by taxonomic status, rank, and other criteria.

Practical examples:

  • Autocompleting scientific names in a biodiversity data entry form.
  • Suggesting accepted scientific names for validation purposes.
  • Filtering name suggestions by taxonomic rank or fuzzy matching to handle misspellings.

Properties

Name Meaning
Dataset Key The dataset ID to query against (required). You can find this key using the Dataset Search resource.
Query The search string for which to suggest scientific names (required).
Accepted Boolean flag to suggest only scientific names that have an accepted taxonomic status.
Fuzzy Boolean flag to enable fuzzy search, allowing approximate matches.
Minimum Rank The minimum taxonomic rank of suggested names. Options range from Domain down to various specific ranks like Species, Subspecies, Variety, Form, etc.
Maximum Rank The maximum taxonomic rank of suggested names. Same options as Minimum Rank.
Reverse Boolean flag to order results in reverse.
Sort By Criterion to sort the results by. Options include Name, Native, Relevance, and Taxonomic.
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 the suggested scientific names matching the query and filters. Each object typically contains details about a scientific name suggestion, including its taxonomic status, rank, and possibly other metadata returned by the ChecklistBank API.

No binary data output is involved.

Dependencies

  • Requires internet access to call the ChecklistBank public API at https://api.checklistbank.org.
  • No internal credentials are required for this resource-operation combination.
  • Uses HTTP GET requests with query parameters constructed from input properties.

Troubleshooting

  • Empty results: Ensure the Dataset Key is correct and that the query string (q) is not empty.
  • Invalid rank values: Use only the provided rank options for minimum and maximum rank fields.
  • API rate limits or downtime: Since this relies on an external API, network issues or API limits may cause errors or no data returned.
  • Incorrect property combinations: For example, setting incompatible filters might yield no results.
  • Error messages: Typically come from HTTP request failures; check network connectivity and API availability.

Links and References

This summary focuses on the Name Usage Suggest - Get operation within the ChecklistBankDataset node, describing its inputs, outputs, and usage context.

Discussion