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 Search → Get

AI-generated

Overview

The node interacts with the ChecklistBank API to retrieve various types of biodiversity and taxonomic data from datasets. Specifically, for the Name Usage Search resource with the Get operation, it performs a search query on name usages within a specified dataset key. This allows users to find scientific names or authorship information matching their query, with options to refine the search by facets, ranks, sorting, and other filters.

This node is beneficial in scenarios where you need to programmatically access detailed taxonomic data, such as integrating species name searches into workflows, validating scientific names, or exploring taxonomic hierarchies. For example, a researcher could use this node to search for all name usages related to a genus or author within a particular dataset.

Properties

Name Meaning
Dataset Key The unique identifier of the dataset to search within.
Query The search string used to find matching name usages.
Content The type of content to search: either "Authorship" or "Scientific Name".
Facet Search facets to filter or categorize results. Options include Alpha Index, Authorship, Authorship Year, Catalogue Key, Dataset Key, Decision Mode, Environment, Extinct, Field, Issue, Name ID, Name Type, Nomenclatural Code, etc.
Facet Limit Maximum number of facet values to return.
Fuzzy Enables fuzzy search to allow approximate matches.
Minimum Rank The lowest taxonomic rank to include in the search (e.g., Domain, Kingdom, Genus, Species, Subspecies, Variety, Form, etc.).
Maximum Rank The highest taxonomic rank to include in the search (same options as Minimum Rank).
Reverse Whether to order the results in reverse.
Sort By The criterion to sort results by: Name, Native, Relevance, or Taxonomic.
Type The type of search: Exact match, Prefix match, or Whole Words match.
Offset The paging offset for result pagination.
Limit The maximum number of results to return (minimum 1).

Output

The node outputs an array of JSON objects representing the search results returned by the ChecklistBank API for the name usage search query. Each object contains detailed information about a name usage record, including fields relevant to the search parameters such as scientific names, authorship, taxonomic ranks, and associated metadata.

No binary data output is produced by this node.

Dependencies

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

Troubleshooting

  • Empty Results: If no results are returned, verify that the Dataset Key is correct and that the query string is valid and expected to yield results.
  • Invalid Dataset Key: Using an incorrect or non-existent dataset key will result in API errors or empty responses.
  • API Rate Limits or Downtime: Since the node depends on an external API, network issues or rate limiting may cause failures. Check connectivity and retry later if needed.
  • Incorrect Parameter Types: Ensure numeric fields like limit and offset are numbers and within allowed ranges.
  • Facet and Rank Filters: Using incompatible or unsupported facet or rank values may lead to unexpected results or errors.

Links and References

Discussion