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

AI-generated

Overview

This node integrates with the ChecklistBank API to retrieve detailed biodiversity and taxonomic data from various datasets. It is designed to fetch information about biological names, taxa, synonyms, references, and related metadata by querying a wide range of resources available in the ChecklistBank system.

The "Name Usage" resource with the "Get" operation allows users to obtain specific usage details of a scientific name within a dataset. This can be useful for researchers, ecologists, or data scientists who need authoritative taxonomic information, such as verifying species names, their ranks, or associated metadata.

Practical examples:

  • Retrieving detailed taxonomic usage information for a given species name key.
  • Querying name usages filtered by rank or search query within a dataset.
  • Integrating taxonomic data into biodiversity informatics workflows.

Properties

Name Meaning
Dataset Key The unique identifier of the dataset to query. You can find this key using the Dataset Search resource.
Additional Fields Optional parameters to refine the query:
- ID: The specific name usage ID to retrieve.
- Query (q): A search string to filter name usages.
- Rank: The taxonomic rank to filter results by. Available ranks include Domain, Kingdom, Phylum, Class, Order, Family, Genus, Species, Subspecies, Variety, Form, and many more detailed taxonomic levels.
- Offset: Paging offset for results.
- Limit: Maximum number of results to return (minimum 1, default 50).

Output

The node outputs an array of JSON objects representing the retrieved name usage data from the ChecklistBank API. Each object contains detailed taxonomic information according to the queried parameters, including identifiers, scientific names, ranks, and other relevant metadata.

The output does not include binary data; it is purely JSON structured data suitable for further processing or integration in workflows.

Dependencies

  • Requires internet access to call the ChecklistBank public API at https://api.checklistbank.org.
  • No authentication credentials are required for this node as per the provided code.
  • Uses standard HTTP GET requests with JSON responses.

Troubleshooting

  • Empty or no results: Ensure the correct Dataset Key is provided and that the query parameters (like ID, rank, or query string) match existing data in the dataset.
  • Invalid Dataset Key: Double-check the dataset key value; invalid keys will result in no data or errors.
  • API rate limits or downtime: Since this node depends on an external API, temporary unavailability or rate limiting may cause request failures.
  • Incorrect parameter types: For example, providing non-numeric values for offset or limit may cause errors.
  • Network issues: Verify network connectivity to the ChecklistBank API endpoint.

Links and References

If you need details on other resources or operations, please specify!

Discussion